Skip to content

Latest commit

 

History

History
executable file
·
77 lines (58 loc) · 4.15 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
77 lines (58 loc) · 4.15 KB
Raw

Contributors Guide

Interested in contributing? Awesome! Before you do though, please read our Code of Conduct. We take it very seriously, and expect that you will as well.

There are many ways you can contribute! ❤️

Bug Reports and Fixes 🐛

  • If you find a bug, please search for it in the Issues, and if it isn't already tracked, create a new issue. Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still be reviewed.
  • Issues that have already been identified as a bug (note: able to reproduce) will be labelled 🐞 Bug.
  • If you'd like to submit a fix for a bug, send a Pull Request and mention the Issue number.

New Features 💡

  • If you'd like to add new functionality to this project, describe the problem you want to solve in a new Issue.
  • Issues that have been identified as a feature request will be labelled 💡 Enhancement.
  • If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending too much time writing the code. In some cases, 💡 Enhancements may not align well with the project objectives at the time.

Miscellaneous ✨

  • If you have an alternative implementation of something that may have advantages over the way its currently done, or you have any other change, we would be happy to hear about it!
  • If its a trivial change, go ahead and send a Pull Request with the changes you have in mind.
  • If not, open an Issue to discuss the idea first.

If you're new to our project and looking for some way to make your first contribution, look for Issues labelled good first issue.

Requirements

For your contribution to be accepted:

  • The changes must be approved by code review.
  • Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.

If the contribution doesn't meet the above criteria, you may fail our automated checks or a maintainer will discuss it with you. You can continue to improve a Pull Request by adding commits to the branch from which the PR was created.

Creating a Pull Request

  1. 🍴 Fork the repository on GitHub.
  2. 🏃 Clone/fetch your fork to your local development machine.
  3. 🌿 Create a new branch and check it out.
  4. 🔮 Make your changes and commit them locally.
  5. ⤴️ Push your new branch to your fork. (e.g. git push username fix-issue-300).
  6. 📥 Open a Pull Request on github.com from your new branch on your fork to main in this repository.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

  • (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

  • (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

  • (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

  • (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Wording of statement copied from elinux.org