Pular para o conteúdo

Pacotes da Comunidade

Como funcionam os links de ADR da comunidade no registro do Archgate, o nível menor de curadoria, a importação a partir de repositórios externos e o futuro builder visual.

Além do catálogo curado, o registro indexa links da comunidade — apontadores para repositórios externos que contêm ADRs compatíveis com archgate, mas que são escritos e mantidos por seus próprios times, não pelos mantenedores do Archgate.

Os links da comunidade permitem que o ecossistema cresça sem que todo pacote precise passar por revisão dos mantenedores. Eles vivem em community/links.yaml como um índice legível por máquina, com um community/README.md legível por humanos ao lado.

Cada entrada em community/links.yaml é um único registro apontando para um repositório externo:

links:
- title: "My ADR Collection"
url: "https://github.com/user/my-adrs"
tags:
- language:typescript
- concern:testing
description: "Short description of what this collection covers."
submittedBy: your-github-username
submittedAt: "2025-01-15"

As tags seguem a mesma convenção <axis>:<value> dos pacotes curados (language:, framework:, runtime:, concern:), de modo que a mesma filtragem se aplica a ambos. O índice começa com um links: [] vazio e cresce através de pull requests da comunidade.

Como a importação é git-native, os links da comunidade usam a forma de URL git em vez do atalho packs/... reservado para o registro oficial. Qualquer coisa que o binário git do sistema consiga clonar funciona — incluindo repositórios privados, que resolvem através da sua autenticação git existente (tokens HTTPS, chaves SSH, gh auth ou credential helpers).

Terminal window
# Paste a GitHub browser URL straight from the address bar
archgate adr import https://github.com/user/my-adrs/tree/main/packs/frontend
# Or the <org>/<repo>/<path> shorthand for a sub-path
archgate adr import user/my-adrs/packs/frontend
# SSH, self-hosted, or any other git URL
archgate adr import [email protected]:team/adrs.git

Um repositório-alvo é compatível com archgate quando tem um archgate-pack.yaml na raiz ou no diretório do pacote, ou pares de ADR-mais-arquivo-de-regra que seguem o formato archgate. Repositórios de terceiros podem usar qualquer layout de diretórios — o caminho que você passa é literal, então um time organizado como teams/frontend/adrs/* ou governance/decisions/* funciona sem a convenção packs/.

  1. Faça um fork do archgate/awesome-adrs.

  2. Adicione uma entrada ao community/links.yaml seguindo o schema acima. Certifique-se de que o repositório-alvo é compatível com archgate.

  3. Abra um pull request usando o template de PR de link da comunidade.

Os mantenedores verificam se o repositório é real, mantido, compatível com archgate e não é spam. Links que ficam inacessíveis são removidos após 30 dias; você pode reportar um link quebrado com o template de issue de link quebrado do repositório.

Se você quiser que sua coleção seja revisada e hospedada dentro do registro com um selo Curated, siga o guia criando um pacote e envie um pacote curado em vez de um link.

Navegar e compor pacotes é uma experiência web, não de terminal — renderização de markdown, código de regra com syntax highlight, busca, filtragem e URLs de seleção compartilháveis são todos nativos na web e custosos numa CLI. Essa superfície é o builder de ADR planejado.

Navegue e filtre

Uma grade de todos os pacotes com tags, contagens de ADRs e descrições. Filtre por linguagem, framework ou preocupação, e alterne entre apenas-curados e curados-mais-comunidade.

Escolha para um conjunto

Abra um pacote ou ADR, leia o documento renderizado ao lado de seu código de regra, e adicione decisões individuais a um carrinho do builder com dicas de dependência.

Copie um comando

O builder emite um comando archgate adr import pronto para executar com cada caminho selecionado — caminhos curados como atalho packs/..., entradas da comunidade como URLs git completas.

Compartilhe uma seleção

As seleções são serializadas em uma URL compartilhável, de modo que um colega abre o link e vê o mesmo conjunto pré-carregado.