2016-09-08 19:35:58 -04:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
Your contributions are always welcome!
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Guidelines
|
|
|
|
|
|
|
|
|
|
- Only one list item per commit.
|
|
|
|
|
|
|
|
|
|
- Only one commit per pull-request.
|
|
|
|
|
|
|
|
|
|
- List item requirements:
|
|
|
|
|
|
2016-09-08 19:45:05 -04:00
|
|
|
- Check the new item you want to add to the list is a [good
|
2016-09-12 05:51:23 -04:00
|
|
|
candidate](README.md#good-candidates).
|
2016-09-08 19:45:05 -04:00
|
|
|
- Must follow this template:
|
2016-09-09 01:59:05 -04:00
|
|
|
`- [Link Title](https://example.com) - A short description.`.
|
|
|
|
|
- Link title must be [title-cased](http://titlecapitalization.com) (AP
|
|
|
|
|
style).
|
2016-12-27 06:00:27 -05:00
|
|
|
- Link title must be stripped out of the "programmers believe" part to
|
|
|
|
|
keep compact.
|
2016-09-08 19:35:58 -04:00
|
|
|
- Keep descriptions concise, maximum number of characters is 350.
|
|
|
|
|
- Description must ends with a period.
|
|
|
|
|
|
|
|
|
|
- Add a section if needed.
|
|
|
|
|
|
|
|
|
|
- Eventually add a description to the section.
|
2016-09-12 05:58:14 -04:00
|
|
|
- Section title must be linked to from the [table of
|
|
|
|
|
contents](README.md#contents).
|
2016-09-08 19:35:58 -04:00
|
|
|
|
|
|
|
|
- Search past and current issues and pull-requests for previous suggestions
|
|
|
|
|
before making a new one, as yours may be a duplicate or a work in progress.
|
|
|
|
|
|
|
|
|
|
- Check your spelling and grammar.
|
|
|
|
|
|
|
|
|
|
- Remove any trailing whitespaces.
|
|
|
|
|
|
|
|
|
|
- Use spaces, no tabs, for indention.
|
|
|
|
|
|
|
|
|
|
- Try to cut long lines of text after 80 characters.
|
|
|
|
|
|
|
|
|
|
- Send a pull-request with the reason why the library is awesome.
|
