Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

34 lines (22 loc) · 1.65 KB
Raw

Contributing Code

Thanks for your interest in contributing code! here's a step-by-step guide as an example of how to do it:

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch for your changes: git checkout -b my-new-feature
  3. Make your changes and commit them: git commit -am 'Add some feature'
    • Include tests that cover your changes.
    • Update the documentation to reflect your changes, where appropriate.
    • Add an entry to the CHANGELOG.md file describing your changes if appropriate.
  4. Push your changes to your fork: git push origin my-new-feature
  5. Create a pull request from your fork to the main repository. gh pr create (with the GitHub CLI)

Contributing Guidelines

We prefer all communications to be in English or Portuguese.

This project uses GitHub Issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new Issue.

For help and questions about using this project, please uses the GitHub discussions.

Pull Request

  • Clearly describe what you aim to add or fix.
  • Try to minimize code changes and use existing style/functions.

Reporting Issues and Bugs

If you find a bug, please report it by opening a new issue in the issue tracker. Please include as much detail as possible, including steps to reproduce the bug and any relevant error messages.

To better respond to issues please follow these general guidelines when explaining the problem.

  1. Clearly describe what you aim to fix, if relevant attach output/logs/screenshots.
  2. Describe how developers can reproduce the bug.