Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BolajiAyodeji authored Mar 11, 2020
1 parent 49d231b commit e220d9e
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,19 @@ You'll need to have some basic experience with Git, Markdown and GitHub
* [Introduction to GitHub](https://product.hubspot.com/blog/git-and-github-tutorial-for-beginners)
* [Popular git commands and how to use them](https://rogerdudler.github.io/git-guide/)
* [Git commands in depth](https://medium.com/@george.seif94/a-full-tutorial-on-how-to-use-github-88466bac7d42)
* [How to Create a Markdown Table](https://www.makeuseof.com/tag/create-markdown-table/)

Ensure your pull request adheres to the following guidelines:

- Search previous suggestions before making a new one to avoid duplicates.
- Make an individual pull request for each suggestion.
- Use [title-casing](https://titlecaseconverter.com/) (AP style).
- Use the following format: `[Title Case Name](link) - Description.`
> :information_source: [Articles](https://github.com/BolajiAyodeji/awesome-jamstack#articles) should use the `[Title Case Name](link)` format.
> :information_source: [Articles](https://github.com/BolajiAyodeji/awesome-technical-writing#resources) should use the `[Title Case Name](link)` format.
- Keep descriptions short and simple, but descriptive.
- Start the description with a capital and end with a full stop/period.
> :information_source: You can use an emoji, only before the Title-Cased Description.
- When adding to the `Examples` category, please add a link to the source code (if available)
- When adding to the `Technical Writers to Follow` category, please a add their Blog and Twitter without breaking the table
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
- New categories or improvements to the existing `table of contents` are welcome.
Expand Down

0 comments on commit e220d9e

Please sign in to comment.