Thank you for considering contributing to ch-rollup! We appreciate your interest and support. By contributing, you help us make our project better for everyone. Please take a moment to review the following guidelines before making any contributions.
We expect all contributors to abide by our Code of Conduct. Please make sure you are familiar with and follow these guidelines in all interactions within our community.
-
Reporting Bugs If you find any bugs or issues within our project, please submit a detailed bug report. Make sure to include steps to reproduce the bug, expected behavior, and any relevant details.
-
Requesting Features If you have ideas for new features or improvements, please submit a feature request. Describe the feature or improvement you'd like to see and why it would be beneficial.
-
Submitting Changes We welcome contributions in the form of pull requests. Before submitting a pull request, please:
- Fork the repository and create your branch from main.
- Make sure your code follows our coding standards and conventions.
- Test your changes thoroughly.
- Update any relevant documentation.
- Ensure your commits are clear and descriptive.
- Run linter (
make lint) and tests (make test) to make sure that your code conforms to the static checks and does not break the tests. - Finally, submit the pull request, explaining the changes you've made and why they're valuable.
Use issues to discuss your thoughts, ideas, and collaborate with other developers. We welcome your participation and contributions to our community!
Your feedback is valuable to us. If you have any suggestions, questions, or concerns, please don't hesitate to contact us via issues.
Thank you for your contributions!
Note: This CONTRIBUTING.md document is subject to change. Please refer to the latest version in the repository for the most up-to-date guidelines.