diff --git a/contributing.md b/contributing.md index ead7fdc..9dffb10 100644 --- a/contributing.md +++ b/contributing.md @@ -2,7 +2,7 @@ Please note that this project is released with a [Contributor Code of Conduct](https://github.com/spring-projects/spring-framework/blob/master/CODE_OF_CONDUCT.adoc). By participating in this project you agree to abide by its terms. -- Do not commit on README, use source.md ! +- Do not commit on README, use SOURCE.md ! Ensure your pull request adheres to the following guidelines: @@ -10,14 +10,13 @@ Ensure your pull request adheres to the following guidelines: - Suggested packages should be tested and documented. - The pull request should have a meaningful title and include a link to the package / resource and why it's awesome. - Make an individual pull request for each suggestion. -- Use the following format: `[resource](link) - Description.` +- Use the following format: `[resource](link) - Description by [Author](link to author)` - Use [title-casing](http://titlecapitalization.com) (AP style). - Additions should be added to the bottom of the relevant category. - New categories, or improvements to the existing categorization are welcome. -- Link to the GitHub repo, not npmjs.com. - Keep descriptions short and simple, but descriptive. - Don't mention `Quantified Self` in the description as it's implied. -- Start the description with a capital and end with a full stop/period. +- Start the description with a capital. - Check your spelling and grammar. - Make sure your text editor is set to remove trailing whitespace.