Pular para o conteúdo
Documentação: Escopos

Escopos

A primeira parte do nome de todo item, e como organizá-los.

A documentação que vem no Ronne AI Marketplace 0.3.0, traduzida do inglês.

O que é um escopo

Um escopo é a primeira parte do nome de todo item, depois do @. Ele agrupa itens relacionados e evita que nomes colidam: @platform/code-reviewer e @mobile/code-reviewer são dois itens diferentes.

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

Quem os cria e usa

  • O root cria os escopos, com uma descrição, em Admin › Scopes. Quando você cria um item, o seletor de escopo lista todos os escopos e mostra a descrição do escolhido.
  • Qualquer pessoa pode propor um item em qualquer escopo. O controle está na revisão, não no escopo: nada é publicado até que um moderador ou o root o aprove.
  • Um escopo não dá a ninguém direitos extras sobre os seus itens. O primeiro autor de um item aparece como dono dele, apenas a título informativo.

Regras de nomes

Escopos e nomes de itens usam letras minúsculas, dígitos e hífens, até 64 caracteres, e não começam nem terminam com hífen. Alguns escopos são reservados, como admin, root e rmk.

O escopo e o nome de um item ficam fixos depois que ele é publicado: um nome novo é um item novo.

Formas de organizá-los

Qualquer uma destas funciona; escolha uma e descreva cada escopo para que as pessoas saibam onde cada coisa vai.

  • Por time: @platform, @mobile, @data. Cada time mantém os próprios itens juntos.
  • Por domínio: @security, @testing, @docs. As pessoas encontram os itens pelo assunto deles.
  • Básicos compartilhados: um escopo, como @platform, para o que todo mundo instala, junto com escopos de time ou de domínio.