Skip to content

Latest commit

 

History

History
81 lines (57 loc) · 3.18 KB

CONTRIBUTING.md

File metadata and controls

81 lines (57 loc) · 3.18 KB
Raw

Contribuindo para o Monitoramento de Gastos Públicos

Obrigado por considerar contribuir para o Monitoramento de Gastos Públicos de Alagoas! Este guia ajudará você a entender como pode ajudar a melhorar o projeto.

Como posso contribuir?

Relatar problemas (Bugs)

Se você encontrar um bug, por favor, nos avise!

  1. Certifique-se de que o bug não foi relatado anteriormente, verificando os issues abertos.
  2. Se for um novo bug, abra um novo issue e forneça informações detalhadas:
    • Descrição do problema
    • Passos para reproduzir o problema
    • Resultado esperado
    • Resultado atual
    • Capturas de tela ou logs, se aplicável

Sugerir melhorias

Achou algo que poderia ser melhorado? Estamos abertos a sugestões!

  1. Verifique se sua sugestão já não foi discutida anteriormente nos issues abertos.
  2. Se for uma nova sugestão, abra um novo issue e forneça informações detalhadas:
    • Descrição da melhoria sugerida
    • Benefícios esperados
    • Qualquer implementação inicial, se aplicável

Contribuir com código

Se você deseja contribuir com código, siga estas etapas:

  1. Fork o repositório: Clique em "Fork" no topo da página do GitHub para criar uma cópia do repositório em sua conta.
  2. Clone o repositório: 
    git clone https://github.com/seu-usuario/2024-2-Squad06.git
  3. Crie uma branch para sua alteração: 
    git checkout -b minha-contribuicao
  4. Faça as alterações necessárias: Implemente as mudanças desejadas no código.
  5. Adicione commits com mensagens claras: 
    git commit -m "Descrição clara do que foi alterado"
  6. Envie as alterações para o seu repositório forked: 
    git push origin minha-contribuicao
  7. Abra um Pull Request: Vá até a página do repositório original e clique em "New Pull Request". Descreva suas alterações detalhadamente.

Padrões de Codificação

  • Siga as convenções de código do projeto.
  • Certifique-se de que seu código está bem comentado.
  • Utilize os padrões de nomenclatura adequados.

Testes

Para garantir que seu código não quebre funcionalidades existentes, por favor, escreva testes para suas alterações e execute os testes existentes:

python3 -m pytest teste_functions.py

Documentação

Se sua alteração afetar a documentação, por favor, atualize-a. A documentação completa do projeto pode ser acessada neste link.

Feedback

Se você tem perguntas ou precisa de ajuda, sinta-se à vontade para abrir um issue ou entrar em contato com a equipe de desenvolvimento.

Código de Conduta

Por favor, leia nosso Código de Conduta para entender as expectativas em relação ao comportamento ao contribuir para este projeto.

Agradecimentos

Agradecemos a todos os nossos colaboradores e aqueles que consideram contribuir para o Monitoramento de Gastos Públicos de Alagoas!