We recommend first starting to learn about Hitnmiss by reading the README. Beyond that you can explore the sections below to identify the path that best fits you. Note: This project follows a contribution code of conduct.
There are a number of ways you can help.
- Report Bugs
- Add Feature Requests
- Add/Update Documentation
- Triage Bugs
- Code Contributions
As a user a relatively easy way to contribute is to report bugs that you run into. Generally, this should be done via our ISSUES page. However, if it is a security issue please send an e-mail directly to one of the core authors found in the gemspec rather than creating a public issue for it. This will give us some time to review it and resolve it before people can abuse the security flaw.
One simple way to get involved after starting to use the project is to contribute by adding feature requests for things that you see as gaps for the project. This can be done by creating an issue or our ISSUES page.
You can also contribute by correcting, updating, or adding additional documentation. This can be done by making a pull request for documentation in any of our top level markdown files.
Triaging bugs is also very important. This is the practice of the reviewing ISSUES, making sure that the submitter provided necessary information to review the bugs, and classify them appropriately.
The most involved type of contribution you can make is to actually submit code to implement features, fix bugs, etc. This is done by submitting a pull request. See DEVELOPING for further details on getting started with a code contribution.