Skip to content

Latest commit

 

History

History
59 lines (59 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

59 lines (59 loc) · 2.98 KB

Contributions to this project are very appreciated, though we require some formalisms:

  1. You are not required to explain everything you did inside code comments. But when you are creating code that spans between multiple files, or it requires more than basic knowledge to be understood, help everyone understand what you are doing by leaving small comments inside your code or by explaining the stream of consciousness inside the pull request.
  2. When creating a pull request, point to an issue or explain what you did using few words (this is an extension of what was said in rule 1).
  3. Not following step 1 and step 2, will not exclude your contribution but it will slow the development process because we will have to make questions before accepting your request.
  4. We will not accept contributions containing shady code or any form of crime.
    Examples of shady code is, but not limited to:
    • References and links to servers we don't own or that are not certified
    • Exposing users to external or internal vulnerabilities
    • Using code tricks to bypass privileges or access reserved memory areas
    Examples of crimes are, but 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. It's not mandatory, but try to follow the already existing code indentation.
  6. Since we believe in a friendly enviroment, memes are permitted in comments. Just don't abuse them and respect rule 4.
  7. You can contribute using your licensed code, though we will have to check few things before:
    1. You are the real author
    2. The contribution respects rule 4
    3. If you propose someone else's code to be integrated, the integration will have to respect the author's needs and will. Basically we have to respect its license.
  8. Last but not least, no one on this planet is born knowning everything. If you respect all the rules above but your pull request is rejected because of the nature of your code, your contribution will not be vain. Your help may give someone else ideas, or the possibility to refactor your code and make it more readable. This is the meaning of open source. Also remember that even us, the creators, started all of this knowing almost nothing, so don't be afraid to be judged.