Aller au contenu
Documentation : Portées

Portées

La première partie du nom de chaque élément, et comment les organiser.

La documentation fournie avec Ronne AI Marketplace 0.3.0, traduite de l'anglais.

Ce qu'est une portée

Une portée est la première partie du nom de chaque élément, après le @. Elle regroupe des éléments liés et évite les conflits de noms : @platform/code-reviewer et @mobile/code-reviewer sont deux éléments différents.

@platform/code-reviewer
@platform/secure-coding
@data/sql-style

Qui les crée et les utilise

  • Le root crée les portées, avec une description, dans Admin › Scopes. Quand vous créez un élément, le sélecteur de portée liste toutes les portées et affiche la description de celle choisie.
  • Tout le monde peut proposer un élément dans n'importe quelle portée. C'est la revue qui contrôle, pas la portée : rien n'est publié avant qu'un modérateur ou le root l'approuve.
  • Une portée ne donne à personne de droits supplémentaires sur ses éléments. Le premier auteur d'un élément est affiché comme son propriétaire, à titre informatif seulement.

Règles de nommage

Les portées et les noms d'éléments utilisent des lettres minuscules, des chiffres et des traits d'union, jusqu'à 64 caractères, et ne commencent ni ne finissent par un trait d'union. Quelques portées sont réservées, comme admin, root et rmk.

La portée et le nom d'un élément sont fixes une fois qu'il est publié : un nouveau nom, c'est un nouvel élément.

Façons de les organiser

N'importe laquelle convient; choisissez-en une et décrivez chaque portée pour que les gens sachent où vont les choses.

  • Par équipe : @platform, @mobile, @data. Chaque équipe garde ses éléments ensemble.
  • Par domaine : @security, @testing, @docs. On trouve les éléments selon leur sujet.
  • Bases communes : une portée, comme @platform, pour ce que tout le monde installe, à côté des portées d'équipe ou de domaine.