Ciclo básico de desenvolvimento

Existem três branches consideradas fixas no repositório do site: a main, a conflitos-pendentes e a revisando, o restante fica a critério dos colaboradores. Quanto mais colaboradores, maior é a necessidade de criar branches adicionais para organizar trabalho e evitar conflitos desnecessários.

Vamos agora explicar as branches consideradas "fixas" e dar uma breve passada no ciclo básico de desenvolvimento do site.

Branch main (link)

É a branch principal do repositório. Todas as modificações feitas nela refletem no site após a realização do processo de deployment.

Branch conflitos-pendentes (link)

É a branch onde existem conflitos que precisam ser resolvidos antes de ser mesclada à main. Muito provavelmente haverá nela textos a serem traduzidos do Inglês, provenientes do projeto PrivacyTools. Os conflitos também não se limitarão ao conteúdo, podendo existir conflitos de arquivos, imagens, e partes técnicas do código-fonte, por exemplo.

Branch revisando (link)

Após a resolução de conflitos em conflitos-pendentes, o site é aperfeiçoado e revisado na branch revisando por todos os colaboradores frequentes ativos do momento.

Passos do Ciclo Básico de Desenvolvimento

1. Uma vez que a branch conflitos-pendentes esteja atualizada com a branch main, modificações feitas no repositório do PrivacyTools.io são trazidas para a branch conflitos-pendentes, gerando inúmeros conflitos e textos a serem traduzidos do Inglês para o Português.
2. Commits devem ser feitos, forçando a inclusão desses conflitos na branch conflitos-pendentes.
3. Este é o passo onde a maioria das contribuições deve ser feita: resolver os conflitos da branch, além de traduzir e atualizar os arquivos do site. Esse trabalho pode ser feito diretamente na branch conflitos-pendentes ou em branches adicionais temporárias, o que é recomendado caso haja um número elevado de colaboradores ativos. Repare que esse passo pode ser subdividido em vários, como: traduzir trechos em Inglês, substituir logotipos do PrivacyTools, modificar links de sites em Inglês para sites em Português, além de resolver conflitos.
4. Após um tempo de trabalho no passo anterior, a branch conflitos-pendentes ficará sem conflitos! Um trabalho de revisão deverá ser feito nesta branch, para ver se o site está funcionando, bem traduzido e com os arquivos de imagem corretos. As modificações da branch então devem ser mescladas à branch revisando e todos os colaboradores ativos devem averiguar a qualidade do site e realizar as melhorias necessárias antes de considerá-lo final.
5. Uma vez que os conflitos sejam resolvidos e os arquivos revisados, os colaboradores devem mesclar as modificações de revisando com a branch main.
6. Colaboradores com acesso ao servidor poderão rodar um script de deployment, para que as modificações da main sejam refletidas no site.
7. O ciclo de desenvolvimento se reinicia. Idealmente, este ciclo deve ser feito no mínimo 1 vez por mês para que o site se mantenha bem atualizado. No entanto não é fácil alcançar e manter esse ritmo.

Dicas e Guias do Ciclo Básico

• O passo 3 é recomendado para iniciantes que desejam ajudar o projeto, e também é o passo mais importante e trabalhoso do ciclo.
• O procedimento dos passos 1-2 é descrito no guia Trazendo atualizações do PrivacyTools.
• O procedimento dos passos 3-4 é descrito no guia Resolvendo conflitos.

Ciclos Alternativos

Ciclos alternativos podem ser realizados em branches temporárias, cujo objetivo seja atender ou resolver um Issue.