Contributing to Bonança
I welcome contributions from the community to help improve Bonança! Whether it's fixing bugs, adding new features, or improving documentation, your contributions are valuable to me. Here are some guidelines to help you get started:
Getting Started
- Fork the Repository: Start by forking the Bonança repository on GitHub to create your own copy of the project.
- Create a Branch: Create a new branch for your feature or bug fix. Use a descriptive name for your branch, such as
add-new-botorfix-index-calculation. - Make Changes: Make your changes in the new branch. Ensure that your code follows the existing coding style and conventions used in the project.
- Test Your Changes: Write tests for your changes to ensure they work as expected and do not introduce new issues. Run existing tests to verify that everything is still functioning correctly.
- Commit Your Changes: Commit your changes with clear and concise commit messages that describe the purpose of the changes.
- Push to Your Fork: Push your changes to your forked repository on GitHub.
- Create a Pull Request: Open a pull request from your branch to the main Bonança repository. Provide a detailed description of the changes you made and any relevant information for reviewers.
Reporting Issues
If you encounter any bugs or have suggestions for new features, please open an issue on the GitHub Issues page. Provide as much detail as possible to help us understand and address the issue.