mirror of
https://github.com/jivoi/awesome-osint.git
synced 2025-02-23 16:09:52 -05:00
Refine CONTRIBUTING.md
This commit is contained in:
parent
d0ad4214ef
commit
c21c5cd457
@ -4,15 +4,14 @@ Please ensure your pull request adheres to the following guidelines:
|
|||||||
|
|
||||||
- Read [the awesome manifesto](https://github.com/sindresorhus/awesome/blob/master/awesome.md) and ensure your list complies.
|
- Read [the awesome manifesto](https://github.com/sindresorhus/awesome/blob/master/awesome.md) and ensure your list complies.
|
||||||
- Search previous suggestions before making a new one, as yours may be a duplicate.
|
- Search previous suggestions before making a new one, as yours may be a duplicate.
|
||||||
- Make sure your list is useful before submitting. That implies it having enough content and every item a good succinct description.
|
- Insert a new entry **alphabetically**. The prefix "The" is not considered in this sorting.
|
||||||
- A link back to this list from yours, so users can discover more lists, would be appreciated.
|
|
||||||
- Make an individual pull request for each suggestion.
|
- Make an individual pull request for each suggestion.
|
||||||
- Titles should be [capitalized](http://grammar.yourdictionary.com/capitalization/rules-for-capitalization-in-titles.html).
|
- Titles should be [capitalized](http://grammar.yourdictionary.com/capitalization/rules-for-capitalization-in-titles.html).
|
||||||
- Use the following format: `[List Name](link)`
|
- Use the following format: `[List Name](link) - additional information.`
|
||||||
- Link additions should be added to the bottom of the relevant category.
|
|
||||||
- New categories or improvements to the existing categorization are welcome.
|
- New categories or improvements to the existing categorization are welcome.
|
||||||
- Check your spelling and grammar.
|
- Check your spelling and grammar.
|
||||||
- Make sure your text editor is set to remove trailing whitespace.
|
- Make sure your text editor is set to remove trailing whitespace.
|
||||||
- The pull request and commit should have a useful title.
|
- The pull request and commit should have a useful title.
|
||||||
|
- In your pull request, include a link in the textual description.
|
||||||
|
|
||||||
Thank you for your suggestions!
|
Thank you for your suggestions!
|
Loading…
x
Reference in New Issue
Block a user