Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (29 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

52 lines (29 loc) · 2.33 KB
Raw

Contributing

First of all, thanks for being here! Contributions are very appreciated, but we ask you to follow a few simple rules so everyone can enjoy the ride.

1. Comment your code (just a little)

You don't need to explain every single line. But if your change spans multiple files, or it takes more than basic knowledge to understand, please leave a few small comments or share your stream of consciousness in the pull request. Future us (and you) will be grateful.

2. Write meaningful pull requests

When opening a PR, link to an issue or describe what you did in a few words. Think of it as an extension of rule 1.

3. About rules 1 and 2

Skipping them won't get your contribution rejected, but it will slow things down, since we'll have to ask questions before merging.

4. No shady code, no crimes

We will not accept contributions containing shady code or any form of crime.

Examples of shady code (not limited to):

  • References and links to servers we don't own or that are not certified
  • Exposing users to external or internal vulnerabilities
  • Code tricks to bypass privileges or access reserved memory areas

Examples of crimes (not limited to):

  • Discrimination based on ethnicity, sex, religion, physical aspect, sexual orientation, or any other individual right protected by Human Rights or by simple logic and maturity
  • Cybercrimes

5. Mind the indentation

Not mandatory, but please try to match the existing code style. It keeps the codebase tidy.

6. Memes are welcome

We believe in a friendly environment, so memes in comments are totally fine. Just don't overdo it, and always respect rule 4.

7. Licensed code

You can contribute with your licensed code, but we'll have to check a few things first:

  1. You are the real author.
  2. The contribution respects rule 4.
  3. If you propose someone else's code, the integration must respect the author's needs and license.

8. Don't be afraid

No one on this planet is born knowing everything. If you follow all the rules above but your PR gets rejected because of the nature of your code, your effort won't be in vain: your work may give someone else ideas, or the chance to refactor it into something even better. That's the beauty of open source.

And remember, even us, the creators, started out knowing almost nothing. So really, don't be afraid of being judged. Just jump in.