Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 2.58 KB

contributing.md

File metadata and controls

41 lines (31 loc) · 2.58 KB
Raw

Contributing

Contributions are welcome and will be fully credited:

  • code contributions are accepted via Pull Requests to this Github repo;
  • financial contributions are usually in the form of donations, projects or jobs;
  • documentation contributions are accepted via Pull Requests to this Github repo;
  • other contributions are most likely welcome in the way you see fit;

Things you could do

If you want to contribute but do not know where to start, this list provides some starting points.

How to do those things

Pull Requests

  • Add tests! - Your patch will be accepted MUCH faster if it has tests.
  • Document any change in behaviour - Make sure the readme.md and any other relevant documentation are kept up-to-date.
  • Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.
  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.
  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Issues

  • Answer all items in the issue template - It helps us resolve problems without a lot of back-and-forth.
  • No support requests - The maintainers and people who follow this project are all busy people. Please do not expect them to help you code something that will only work inside your project or debug an issue that is most likely your own doing.

Rules for writing effectively

This project stands by The Whole Fruit Manifesto. We believe that “writing good code” is not only about “writing good code”. It’s also about the words around it. That’s why, to make sure your contribution is well received, we ask you to read and apply the ONE=MOR framework and guidelines when writing comment blocks, PR titles, PR descriptions, and in general, when writing to our community.

Happy coding!