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 e220d9e commit c64b9dc
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ 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-technical-writing#resources) should use the `[Title Case Name](link)` format.
- Use the following format: `[Title Case Name](link)`
> :information_source: [Useful Tools](https://github.com/BolajiAyodeji/awesome-technical-writing#useful-tools) should use the `[Title Case Name](link)` format with a description.
- 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 `Technical Writers to Follow` category, please a add their Blog and Twitter without breaking the table
- When adding to the `Technical Writers to Follow` category, please add a link to 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.
- New categories or improvements to the existing `Table of Contents` are welcome.
- Pull requests should have a useful title and description.
- The body of your commit message should contain a link to the resource.

Expand Down

0 comments on commit c64b9dc

Please sign in to comment.