We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Proposing new features
- Contributing bug fixes, features, and new utilities
- GEM utilities has online documentation available.
- If you need help and do not easily find an answer in the documentation, ask your question in a new issue.
- Any question that you have likely indicates a shortcoming in the documentation, which we will want to fix as well.
-
Check if the bug / feature request was not already reported by searching on GitHub under Issues.
-
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible.
-
If you are reporting a bug, it will be much easier to fix if you include a code sample or an executable test case demonstrating the expected behavior that is not occurring.
We use GitHub to host code and documentation, to track issues and feature requests, as well as accept pull requests.
Pull requests are the best way to propose changes to the codebase (we use the Github Flow contribution models). We actively welcome your pull requests:
- Fork the GitHub repository
and create your branch from
develop. - If you've added code that should be tested, add tests.
- If you've added new features, update the documentation.
- Ensure the test suite passes (make sure you enable GitHub actions in your fork!)
- Make that pull request! Please ensure the pull request description clearly describes the problem and solution. Include the relevant issue number if applicable.
In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.
No proprietary or copylefted code will be accepted!
We strongly suggest that you propose your change in a new issue and collect feedback before you start writing code or open a pull request.