Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
95 lines (59 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

95 lines (59 loc) · 3.16 KB

Contribuindo para dataGPT

Obrigado por considerar contribuir para o dataGPT! Aqui estão algumas diretrizes para ajudar você a começar:

Como Contribuir

  1. Faça um fork do repositório.
  2. Crie uma branch para sua feature (git checkout -b feature/nome-da-feature).
  3. Commit suas mudanças (git commit -m 'Adiciona nova feature').
  4. Envie para o branch (git push origin feature/nome-da-feature).
  5. Abra um Pull Request.

Reportando Problemas

Se você encontrar um bug ou tiver uma sugestão, por favor, abra uma issue no repositório.

Testes

Certifique-se de que suas mudanças passaram nos testes antes de enviar um Pull Request. Adicione testes para qualquer nova funcionalidade adicionada.

Estilo de Código

Siga as seguintes diretrizes de estilo de código para garantir a consistência no código-base:

Mensagens de Commit

  • Use o tempo presente ("Adiciona feature" e não "Adicionou feature")
  • Use o modo imperativo ("Move cursor para..." e não "Moveu cursor para...")
  • Limite a primeira linha a 72 caracteres ou menos
  • Referencie issues e pull requests liberamente
  • Considere iniciar a mensagem de commit com um emoji aplicável:
    • 🎉 :tada: quando criar uma nova release
    • 🐛 :bug: quando corrigir um bug
    • 📝 :memo: quando escrever documentação

Estilo de Código Python

Siga o guia de estilo PEP 8.

Estilo de Documentação

Siga o Guia de Estilo do Google para documentação.

Código de Conduta

Por favor, leia nosso Código de Conduta para entender nossas expectativas em relação à participação da comunidade.

Contributing to dataGPT

Thank you for considering contributing to dataGPT! Here are some guidelines to help you get started:

How to Contribute

  1. Fork the repository.
  2. Create a branch for your feature (git checkout -b feature/feature-name).
  3. Commit your changes (git commit -m 'Add new feature').
  4. Push to the branch (git push origin feature/feature-name).
  5. Open a Pull Request.

Reporting Issues

If you find a bug or have a suggestion, please open an issue in the repository.

Tests

Ensure that your changes pass the tests before submitting a Pull Request. Add tests for any new functionality added.

Code Style

Follow these code style guidelines to ensure consistency in the codebase:

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moved cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally
  • Consider starting the commit message with an applicable emoji:
    • 🎉 :tada: when you create a release
    • 🐛 :bug: when you fix a bug
    • 📝 :memo: when you write docs

Python Code Style

Refer to the PEP 8 style guide for Python code.

Documentation Style

Follow the Google Style Guide for documentation.

Code of Conduct

Please read our Code of Conduct to understand our expectations regarding community participation.