Solicitações de Mudança de Arquitetura
As Solicitações de Mudança de Arquitetura permitem propor modificações ao seu modelo C4 através de um fluxo de trabalho de revisão estruturado. Em vez de editar a arquitetura diretamente, os membros da equipe criam solicitações que podem ser revisadas, discutidas e mescladas.
Como Funciona
Uma solicitação de mudança agrupa uma ou mais alterações propostas ao seu modelo de arquitetura. Ela segue um ciclo de vida similar a um pull request em repositórios de código:
- Crie uma solicitação com um título e descrição
- Adicione mudanças — crie, atualize ou exclua elementos C4 (sistemas, containers, componentes, elementos de código, relacionamentos, overlays)
- Abra para revisão quando a proposta estiver pronta
- Revisão — membros da equipe aprovam, solicitam mudanças ou deixam comentários
- Mescle para aplicar todas as mudanças à arquitetura ao vivo
Ciclo de Vida da Solicitação
Cada solicitação passa por estes status:
| Status | Descrição |
|---|---|
| Rascunho | Trabalho em andamento. Apenas o autor pode ver e editar mudanças. |
| Aberta | Enviada para revisão. Membros da equipe podem revisar e comentar. |
| Aprovada | Recebeu aprovações e está pronta para mesclar. |
| Mesclada | As mudanças foram aplicadas ao modelo de arquitetura. |
| Fechada | Recusada ou abandonada. Pode ser reaberta pelo autor. |
Criando uma Solicitação
A Partir da Aba Solicitações
- Navegue até seu projeto
- Abra a aba Solicitações
- Clique em Nova Solicitação
- Insira um título (máximo 200 caracteres) e descrição opcional
- A solicitação começa no status Rascunho
Adicionando Mudanças
Dentro de uma solicitação rascunho ou aberta, adicione mudanças selecionando:
- Operação: Criar, Atualizar ou Excluir
- Tipo de elemento: Sistema, Container, Componente, Código, Relacionamento ou Overlay
- Dados do elemento: As propriedades para o elemento novo ou modificado
As mudanças são agrupadas por tipo de operação (criações, atualizações, exclusões) para facilitar a revisão.
Editando uma Solicitação
O autor pode editar o título e a descrição de uma solicitação a qualquer momento, desde que não tenha sido mesclada.
Revisando uma Solicitação
Enviando uma Revisão
Membros da equipe com acesso de edição podem revisar solicitações abertas:
- Aprovar — a proposta parece boa
- Solicitar Mudanças — modificações são necessárias antes da mesclagem
- Comentar — deixar feedback sem uma decisão formal
Feed de Atividade
A aba de atividade mostra todas as revisões e comentários em ordem cronológica.
Mesclando uma Solicitação
Quando uma solicitação foi revisada e aprovada:
- Abra a página de detalhes da solicitação
- Clique em Mesclar
- Todas as mudanças são aplicadas atomicamente ao modelo C4
Apenas membros da equipe com permissões de edição podem mesclar solicitações.
Pré-visualizando Mudanças
A aba Pré-visualização mostra uma representação visual de como a arquitetura ficará após as mudanças serem aplicadas, para que os revisores possam entender o impacto antes de mesclar.
Boas Práticas
Escreva Títulos Claros
Use títulos descritivos que expliquem a intenção:
- "Adicionar serviço de pagamento e integração Stripe"
- "Dividir API monolítica em serviços de usuário e pedido"
- "Remover componente de notificação descontinuado"
Mantenha Solicitações Focadas
- Uma mudança lógica por solicitação
- Evite misturar modificações não relacionadas
- Solicitações menores são mais fáceis de revisar
Use Descrições
Explique o raciocínio por trás das mudanças propostas:
- Por que esta mudança arquitetural é necessária
- Quais alternativas foram consideradas
- Links para ADRs ou documentação relacionada
Revise Antes de Mesclar
- Pelo menos uma aprovação é recomendada
- Use comentários para discutir trade-offs
- Verifique a aba de pré-visualização para confirmar o resultado
Próximos Passos
- Visão Geral do Modelo C4 — Entenda o modelo de arquitetura
- Equipes — Configure sua equipe para revisões colaborativas
- Documentação — Vincule ADRs a decisões de arquitetura