Thank you for considering contributing to our project. To ensure that all contributors have a positive experience, we have established some guidelines that you should follow.
Before you begin contributing, make sure to read our Code of Conduct to understand how we expect community members to interact with each other.
- Fork the repository on GitHub.
- Create a branch in your fork with a descriptive name indicating the change you are making.
- Make the changes in your branch.
- Make sure your changes follow clean architecture patterns and coding best practices in Go.
- Run tests to ensure you haven't introduced any errors.
- Create a pull request from your branch to the main branch of the repository.
- Wait for the team to review your pull request. If changes are needed, make sure to make them before submitting a new review.
- Once your pull request is approved, the team will merge it into the main branch.
If you find a bug or issue in the project, please follow these steps to report it:
- Open an issue on the repository describing the problem as detailed as possible.
- Provide an example of the incorrect behavior and how it can be reproduced.
- Provide information about the environment in which you are running the code, including the version of Go you are using.
- If you have a solution for the problem, please submit a pull request following the guidelines established above.
To ensure that pull requests integrate smoothly, please follow these guidelines:
- Follow the guidelines established in our Code of Conduct.
- Make sure your code follows Go's coding conventions, including formatting and style.
- Make sure your code follows clean architecture patterns and coding best practices in Go.
- Make sure your changes do not break any existing tests, and you have added tests for any new functionality.
- Create a detailed description of the changes you made and why you made them.
Thank you for contributing to our project. Your time and effort are greatly appreciated.