Guia do Contribuidor

Recentemente nos mudamos do Only Dust para o GrantFox: https://www.grantfox.xyz/

Bem-vindo à comunidade open-source Trustless Work! 🚀 Agradecemos seu interesse em contribuir e nos ajudar a construir Infraestrutura de Escrow para a Nova Economia. Este guia irá orientá-lo no processo de contribuição de forma eficaz.

Uma vez designada uma tarefa, por favor siga estas diretrizes:

---

🔹 1. Começando

Fork e clone o repositório

1. Fazer fork do repositório no GitHub.

2. Clonar seu repositório forkado para sua máquina local:

   git clone https://github.com/SEU_USUARIO/NOME_DO_REPOSITORIO.git
   cd NOME_DO_REPOSITORIO

3. Defina o remote upstream para sincronizar com o repositório principal:

   git remote add upstream https://github.com/TrustlessWork/NOME_DO_REPOSITORIO.git

4. Garanta que você está na versão mais recente de develop:

   git checkout develop
   git pull upstream develop

---

🔹 2. Estratégia de Branching

Seguimos um modelo de branching estruturado para manter as contribuições organizadas.

Branches principais

• main → O pronto para produção branch (NÃO envie commits diretamente aqui).

• develop → O desenvolvimento ativo branch onde as funcionalidades são mescladas.

Branches de Feature & Fix

Crie uma branch com base no tipo de alteração:

• Funcionalidades: feat/nome-da-feature

  • Exemplo: feat/escrow-ui

• Correções de bugs: fix/descrição-do-bug

  • Exemplo: fix/erro-na-resposta-da-api

• Documentação: docs/atualizar-nome

  • Exemplo: docs/guia-de-como-comecar

• Refatoração: refactor/melhora-de-codigo

  • Exemplo: refactor/limpar-smart-contracts

Criar uma nova branch

Sempre crie uma nova branch antes de fazer alterações:

   git checkout develop
   git pull upstream develop  # Sincronize com o código mais recente
   git checkout -b feat/nova-feature

---

🔹 3. Fazendo Contribuições

Padrões de Codificação

✅ Mantenha as alterações pequenas e atômicas. ✅ Siga as diretrizes de mensagens de commit (veja abaixo). ✅ Garanta que os testes passem antes de submeter um PR. ✅ Formate o código usando nossas regras de lint e formatação.

Diretrizes de Mensagens de Commit

Use um formato de mensagem de commit claro e conciso:

tipo: descrição curta (menos de 72 caracteres)

Exemplos:

• feat: adicionar sistema de aprovação de escrow

• fix: resolver problema de timeout da API

• docs: atualizar README com instruções de configuração

Tipos:

• feat: Nova funcionalidade

• fix: Correção de bug

• docs: Atualização de documentação

• refactor: Reestruturação de código

• style: Formatação de código (sem alterações de lógica)

• test: Adição ou atualização de testes

• build: Alterações no processo de build ou dependências

• ci: Alterações na configuração de CI/CD

• chore: Atualizações diversas

---

🔹 4. Enviando Alterações & Criando um PR

Envie Suas Alterações

   git add .
   git commit -m "feat: add escrow approval system"
   git push origin feat/nova-feature

Criar um Pull Request (PR)

1. Vá para o repositório original no GitHub.

2. Clique em Novo Pull Request.

3. Selecione develop como a branch base e sua branch de feature como a branch de comparação.

4. Forneça uma descrição clara das alterações.

5. Envie para revisão!

---

🔹 5. Processo de Revisão de Código & Merge

✅ Mantenedores irão revisar o PR e fornecer feedback. ✅ Se solicitado, faça alterações e envie atualizações ao seu PR. ✅ Uma vez aprovado, o PR é mesclado em develop. ✅ Após os testes, develop é mesclado em main para produção.

---

🔹 6. Recursos Adicionais

📖 Trustless Work no GitHub – Navegue por nossos repositórios. 💬 Junte-se ao nosso Telegram – Conecte-se com outros colaboradores.

Boas codificações! 🎉