|
@@ -6,10 +6,14 @@ Please ensure your pull request adheres to the following guidelines:
|
|
|
- Search previous suggestions before making a new one, as yours may be a duplicate.
|
|
|
- Make sure your suggestion is useful before submitting. That implies it having enough content and every item a good succinct description.
|
|
|
- Make an individual pull request for each suggestion.
|
|
|
-- Use the following format: `[Title](link). Short author description` where `Short author description` strictly starts from a definition of a project. No **articles** or **project name repetitions** is allowed!
|
|
|
- - Good: `[Hello world](example.com). Classic minimal project.`
|
|
|
- - Bad: `[Hello world](example.com). A classic minimal project.`
|
|
|
- - Bad: `[Hello world](example.com). Hello world is classic minimal project.`
|
|
|
+- Use the following format: `[Title](link). Short author description <LineBreak> // *Your short comment*` where:
|
|
|
+ - `Title` is the official name of a project
|
|
|
+ - `link` points to source repository or, *if absent*, any info/download page. If you feel necessary to add a link to some site and a repository info doesn't point to it (no README or whatever), you can add link(s) after the main one: `[Title](link) ([Docs](example.com), [Active fork](example.com), etc).`
|
|
|
+ - `Short author description` strictly starts from a definition of a project. No **articles** or **project name repetitions** is allowed!
|
|
|
+ - :white_check_mark: Good: `[Hello world](example.com). Classic minimal project.`
|
|
|
+ - :x: Bad: `[Hello world](example.com). A classic minimal project.`
|
|
|
+ - :x: Bad: `[Hello world](example.com). Hello world is classic minimal project.`
|
|
|
+ - `Your short comment` (*optional*) is a really short comment that you're sure will be useful for others
|
|
|
- Link additions should be added to the bottom of the relevant category.
|
|
|
- New categories or improvements to the existing categorization are welcome. In most cases, new category should go **before** `Unit Testing` category as the end of the list is dedicated for developer tools and then various utilities.
|
|
|
- Check your spelling and grammar.
|