Thank you for considering contributing to our project! We appreciate your interest and value the contributions from our community. To ensure a smooth collaboration, we have established the following guidelines to help you understand the contribution process and make your experience as positive and effective as possible.
Familiarize yourself with the project's purpose, goals, and architecture. Explore the existing documentation, including the README file. Check the issue tracker and pull requests to see if your desired contribution is already being discussed or worked on. Join our community discussion channels to engage with other contributors and seek guidance if needed.
If you encounter a bug or have a suggestion, please submit an issue in the project's issue tracker. Clearly describe the problem or feature request, providing as much relevant information as possible.
We welcome new ideas and feature requests! Before submitting a request, please search the issue tracker to ensure it hasn't been suggested already. Clearly explain the proposed feature and its benefits.
Fork the repository and create a new branch for your contribution. Follow the project's coding standards and guidelines. Write clear and concise commit messages. Test your changes thoroughly. Update the documentation if necessary. Make sure your code passes all existing tests and linters. Submit your contribution as a pull request and link it to an issue with "Fixes #issue-number" in the description of the PR.
Follow the established coding style and conventions used in the project. Write clean, readable, and well-documented code. Use descriptive variable and function names. Keep your code modular and maintainable. Strive for consistency with existing code.
Write unit tests to cover your code changes. Ensure that existing tests still pass after your modifications. Include clear instructions on how to test your changes effectively.
Document any new features or changes you introduce. Update the project's documentation to reflect your contribution. Provide examples or code snippets, if applicable. Add API documentation (e.g. Javadoc) to any new public API. Make sure the documentation is clear, concise, and easy to understand.
Sign the Gluon Individual Contributor License Agreement (CLA) before opening a pull request. Include a descriptive title and summary of your changes. Reference related issues or feature requests, if applicable. Include step-by-step instructions on how to test your changes. Be responsive to feedback and participate in the review process. Once approved, your pull request will be merged by a project maintainer.
Reviewers should provide constructive feedback and suggestions. Be respectful and considerate when providing comments. Approve the pull request if the contribution meets the project's standards.