Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

32 lines (19 loc) · 1.88 KB
Raw

Contributing to JOSESwift

Thanks for taking the time to contribute to the project.

🎉 First step done: All kinds of contributions are highly appreciated and very welcome.

Code of Conduct

Everyone who participates in this project sticks to the Code of Conduct.

I want to contribute, but how?

For feature contributions or bug fixes, please submit a pull request. For feature requests, discussions or bug reports, just open an issue.

Pull Request Process

  1. If applicable, make sure your pull request includes tests that thoroughly cover newly added lines.
  2. Please don’t forget to update the README.md and other documentation with relevant details of changes.
  3. Submit your pull request to master.
  4. Provide a detailed description of your changes in the pull request description. Reference any resolved issues or previous discussions in other pull requests.
  5. Pull requests will need to be approved before being merged. The better the pull request description, the easier and quicker a pull request will be to review.
  6. Once approved, the pull request can be squash merged into master and we’re done. 🎉

General

Please make sure to stick to general coding best practices and Swift code style as good as possible. You can find more info on that in GitHub’s Swift Style Guide, the official Swift API Design Guidelines.

Please also make sure that relevant code is documented and tested. 📃

More information on how to create a pull request can be found in this tutorial. 🎓

GitHub also has a nice blog post on how to create the perfect pull request. ✨