Commit-Boost is community driven and we welcome all contributions.
If you contribute to this repo, your contributions will be made to the project under both Apache 2.0 and the MIT license.
There are fundamentally three ways you can contribute:
- By opening an issue: For example, if you believe that you have uncovered a bug
- By adding context: Providing additional context to existing issues
- By resolving issues: For example by opening a PR
For first-time contributors we will not be accepting PRs that only fix spelling or grammatical errors in documentation, code or elsewhere.
If you believe you have found a security issues, please do not open a public issue but check out our Security policy instead.
If you find a non-security related bug, please file an issue detailing:
- Release version you are using
- Code snippets and/or logs that can help identifying the bug
- Concrete steps to reproduce the bug
If you have a suggestion for a new feature or an improvement to an existing one, please open a new issue and provide:
- A clear and concise description of the feature you’d like to see implemented.
- An explanation of why this feature would be helpful or what problem it would solve.
- Any relevant examples, mock-ups, or references that can help illustrate your idea.
We value your input and appreciate all suggestions to help make this project better!
We welcome PRs from any community member. Before making a large change, it is usually a good idea to first open an issue describing the change to solicit feedback and guidance. This will increase the likelihood of the PR getting merged.