1
0
Fork 0
mirror of https://github.com/kdeldycke/awesome-falsehood.git synced 2024-11-20 11:35:56 -05:00
falsehood/CONTRIBUTING.md

46 lines
1.4 KiB
Markdown
Raw Normal View History

2016-09-08 19:35:58 -04:00
# Contributing
Your contributions are always welcome!
## Guidelines
- Only one list item per commit.
2017-09-19 10:51:51 -04:00
- Only one commit per pull-request. Always squash commits after applying
changes.
2016-09-08 19:35:58 -04:00
- List item requirements:
- 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).
- Must follow this template:
2016-09-09 01:59:05 -04:00
`- [Link Title](https://example.com) - A short description.`.
2017-09-19 10:51:51 -04:00
- Link title must be [title-cased](http://titlecapitalization.com), AP style.
- Link title must be stripped out of the "*programmers believe*" part to keep
it compact.
2017-01-11 08:57:55 -05:00
- URL must use HTTPs protocol if available.
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).
2017-09-19 10:53:59 -04:00
- Sections must be alphabetically sorted.
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.
2017-09-19 10:51:51 -04:00
- Cut long lines of text after 80 characters. Only exception is to let Markdown
content be properly rendered.
2016-09-08 19:35:58 -04:00
2017-09-19 10:51:51 -04:00
- Send a pull-request with the reason why the linked resource is awesome.