Guia de contribuição

Contribuindo para o Projeto - Brasil Participativo

Obrigado(a) por considerar contribuir para este projeto! Valorizamos o envolvimento da comunidade para melhorar continuamente.

Antes de começar, sugerimos que você leia nosso código de conduta para garantir um ambiente respeitoso e colaborativo.

Como Contribuir

1. Fork o projeto para sua conta.
2. Crie um branch para a sua contribuição: git checkout -b feature-nova.
3. Faça suas alterações e comita: git commit -m 'Adiciona nova feature'.
4. Envie para o seu fork: git push origin feature-nova.

5. Abra um pull request neste repositório.

6. Para mantermos o padrão dos passos acima, consulte os guias. Padrão de Commit e Branches

Padrões de Codificação

Por favor, siga os padrões de codificação e estilo estabelecidos neste projeto. Certifique-se de que seu código está formatado corretamente.

Com isso, nomes de variáveis devem ser definidos seguindo o camel case, nomes começando com letra minuscula, palavras juntas e sem acentos, com a letra maiúscula indicando onde haveria espaço. EX: estaVariavel.

Para outras práticas de codificação serão seguidas o PEP8.

Obs: Você pode executar o Pylint para auxiliar a manter o padrão de qualidade do projeto. E.g pylint directory/mymodule.py

Instalando o pylint

Para utilizar o pylint deve ser instalado executando o seguinte comando: pip install pylint

O pylint pode ser integrado em diversas IDEs, pode ser verificado esta possibilidade na documentação.

Reportando Problemas

Se você encontrar problemas ou bugs, por favor, abra uma issue descrevendo o problema. Inclua informações detalhadas sobre como reproduzir o problema e o ambiente em que ele ocorreu.

Sugestões e Melhorias

Adoramos receber sugestões e melhorias! Sinta-se à vontade para abrir uma issue para discutir novas ideias ou melhorias para o projeto.

Licença

Ao contribuir, você concorda que suas contribuições serão licenciadas sob a Licença do Projeto.

---

Agradecemos suas contribuições!

Contato: chatbotbrasilparticipativo@gmail.com

Histórico de versão

Versão	Data	Descrição	Autor
1.0	28/03/2024	Criação do histórico de versão	Gabriel Scheidt
1.1	01/04/2024	Adição de links de políticas de commits e licença	Arthur Taylor
1.2	03/04/2024	Definição dos pdrões de codificação	Arthur Taylor