Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

41 lines (23 loc) · 2.28 KB
Raw

Before getting started

On the first paragraph, take some lines to thank your future contributors. It motivates people and makes you more human.

How to contribute

Expose your project guidelines about how to contribute to it. Offer resources that people could use to discuss changes they wish to make, ask questions and talk about how they could help (and what needs their help).

If you need further guidance, you can find our team on the following:

  • IRC channel
  • Skype
  • Mailing list
  • Some Project Management tool.

ProTip: Now this is a good time to remind people to follow some rules and to be polite while contributing:

Please note we have a code of conduct, please follow it in all your interactions with the project.

Getting started

Here you should address guidelines about future functionalities, milestone labels, bugs and unlisted features, issued assignments, etc. Since now we have an Issue and a Pull Request template, you can reference them directly:

For further guidance about getting started, please refer to the related links:

ProTip: It's important people know the rules for contributing in the project. It's irritating for people trying to help when they are pushed back because they didn't follow some process that they didn't know existed. This file is the place for these processes and it will lower the barrier to entry for contribution.

Coding conventions

Code should be optimized for readability. Attach some custom style guide or reference some. i.e.:

In order to sanitize coding standards, please follow this style guide.

Code of Conduct

This section should explicitly state that we will not discriminate against people on any grounds other than their code contributions, and make clear that behaviour that would be harmful to other people that may wish to contribute is not acceptable. This gives clear authority to remove people who are causing problems, and also sets a clear tone of inclusion.

ProTip: You can find more about Contributor Covenant or as a seperate code_of_conduct file. Good sample.