We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
- Tell your friends about it or leave a star
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 (we use Gitflow). We actively welcome your pull requests:
- Fork the repo and create your branch from
develop. - If you've added code that should be tested, add unit tests (we use Quick and Nimble).
- If you've changed APIs, update the code documentation and run the
Scripts/release.shfrom the project's root to re-generate the jazzy-docs. - Ensure the test suite passes.
- Extend the example projects for all platforms to showcase your feature.
- Make sure your code lints. Please run the
Scripts/setup.shfrom the project's root to install the required tools. - Issue that pull request!
We use GitHub issues to track public bugs. Report a bug by opening a new issue and fill out the provided template. It's that easy!
You can open a new issue to file feature requests. Again, please stick with the provided template.
By contributing, you agree that your contributions will be licensed under its MIT License.
This document was adapted from briandk