Thank you for your interest in contributing to this project. Any bug reports, new features, correction, or additional documentation are welcome.
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
Krabs uses the “fork-and-pull” development model. Follow these steps if you want to merge your changes to Krabs:
- Within your fork of Krabs, create a branch for your contribution. Use a meaningful name.
- Create a pull request against the master branch of the repository.
- Once the pull request is approved, Krabs will merge it.
Krabs welcome you to use the GitHub issue tracker to report bugs or suggest features.
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
- A reproducible test case or series of steps
- The version of our code being used
- Any modifications you've made relevant to the bug
- Anything unusual about your environment or deployment