We welcome all feedback on OpenMinter, and we wish to make contributing as easy as possible for interested participants. These contributions can include but aren't limited to:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
Pull requests are the best way to propose changes to the codebase.
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed anything major, update the documentation.
- Ensure the test suite passes and your code lints.
- Open the PR, specifically targeting our
developbranch.
All code changes will be subject to the same MIT License that currently covers the project. Make sure to keep this in mind when submitting any changes.
Report bugs using issues
We use GitHub issues to track bugs and manage how they're addressed. Please make sure to open a new issue when reporting a bug, or search existing issues to see if the bug has alreqady been reported.
Please be sure to report your issues with detail, background, and sample code if applicable. The more associated detail, the easier it is to address.
Be sure to include:
- A quick summary
- Your current build environment
- Steps to reproduce
- What you expected to happen
- What actually happened
- Notes
By contributing, you agree that your contributions will be licensed under its MIT License.
This document was adapted from the contribution guidelines from Transcriptase