Skip to content

Latest commit

 

History

History
50 lines (26 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

50 lines (26 loc) · 1.81 KB

Welcome to the contribution guide

First of all - we would like to thank you for looking into how to contribute to the project.

As this project is not commercial, everyone who wants to contribute is worth their weight in gold.

The flow to contribute to the project

The project can be contributed to in this way:

  1. Create a fork of this project

    To create a fork, click on the button commonly located in the upper-right corner of the page:


Fork button in the upper-right corner


Or just click here

  1. Find an issue to work on

    Go through the list of issues of the project and find an issue which sounds interesting to you.

    Issues labelled as [help wanted] are good targets for getting accustomed to the project.

  2. Work on the issue on your fork of the project

    It would be best if your work had tests and documentation, so others can easily understand and review the code.

  3. When you are done, submit a Pull Request

    The pull request should generally abide to the Bug Report or a Feature Request templates, but it is not enforced.

  4. The Pull Request is denied

    If your Pull Request is denied, it will most likely not get closed. You will get a comment on it that highlights the things you would have to fix. After doing that, the Pull Request will surely get accepted!

  5. The Pull Request is accepted

    Congratulations, and thanks for collaborating on the project!

License & Contributing

The project is licensed under the MIT License.

By contributing to the project you agree to release the code added under the same license (MIT).