If you find a bug or have a suggestion for improving the project, please start by checking if a similar issue already exists. If not, feel free to open a new issue with a clear description, including:
- Steps to reproduce the issue.
- Expected behavior.
- Actual behavior.
- Environment details (Go version, OS, etc.).
To contribute, please follow these steps:
-
Fork the Repository: Click the 'Fork' button on the repository page to create your own copy of the repository.
-
Create a Branch: Create a branch in your fork for your changes. It's best to name the branch something descriptive.
-
Make Your Changes: Implement your changes, adhering to the coding standards and guidelines of the project.
-
Write Tests: Ensure that your changes are covered by tests. We strive to maintain a high level of code quality and test coverage.
-
Run the Tests: Before submitting your changes, make sure all tests pass.
-
Update Documentation: If your changes involve user-facing features or interfaces, update the README or other relevant documentation.
-
Commit Your Changes: Use clear and descriptive commit messages.
-
Submit a Pull Request: Push your changes to your fork and open a pull request to the main repository. In the pull request description, explain your changes and reference any related issues.
-
Code Review: Once your pull request is open, the maintainers will review your changes. Be open to feedback and making revisions if requested.
Maintainers will review your pull request. We aim for a prompt review, but response times can vary based on availability. During the review process, we may:
- Provide feedback and request changes if necessary.
- Merge your pull request once it is approved and all criteria are met.
- Follow Effective Go guidelines.
- Ensure code is formatted with
go fmt. - Write idiomatic and readable Go code.
- Add comments where necessary, especially for public functions and interfaces.