Contributing Guidelines

Code of Conduct

This project is intended to be a safe, welcoming space for collaboration. All contributors are expected to adhere to the Contributor Covenant code of conduct. Thank you for being kind to each other!.

Contributions welcome!

Before spending lots of time on something, ask for feedback on your idea first!

Please search issues and pull requests (or in any of the related projects) before adding something new! This helps avoid duplicating efforts and conversations.

This project welcomes any kind of contribution! Here are a few suggestions:

  • Ideas: participate in an issue thread or start your own to have your voice heard.
  • Writing: contribute your expertise in an area by helping expand the included content.
  • Copy editing: fix typos, clarify language, and generally improve the quality of the content.
  • Formatting: help keep content easy to read with consistent formatting.
  • Code: help maintain and improve the project codebase.

How to become a contributor and submit your own code

Contributor License Agreements

We’d love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles. Please fill the Contributor License Agreement (CLA).

This shoudl be an automated process if you send us some pull-request.

Contributing A Patch

  1. Submit an issue describing your proposed change to the repo in question.
  2. The repo owner will respond to your issue promptly.
  3. If your proposed change is accepted, and you haven’t already done so, sign a Contributor License Agreement (see details above).
  4. Fork the desired repo, develop and test your code changes.
  5. Ensure that your code adheres to the existing style in the sample to which you are contributing.
  6. Ensure that your code has an appropriate set of unit tests which all pass.
  7. Submit a pull request.

Other contributions

If you don’t have enough time for any of the tasks above, and you want to contribute with the project, you could buy us some coffee, beer and pizza.

If you would like to donate via Bitcoin, please send your donation to this wallet:

Bitcoin: 1G9d7uVvioNt8Emsv6fVmCdAPc41nX1c8J