mirror of
https://github.com/jivoi/awesome-osint.git
synced 2025-01-09 06:27:58 -05:00
fix
This commit is contained in:
parent
b02efb83c0
commit
1ad072d347
@ -1,22 +1,18 @@
|
|||||||
# Contribution Guidelines
|
# Contribution Guidelines
|
||||||
|
|
||||||
This is a compilation of **Free and Libre Open Source Software ([FLOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software))**. Restrictive licenses (aka Freeware, Shareware) are *not awesome*.
|
Please ensure your pull request adheres to the following guidelines:
|
||||||
|
|
||||||
## Commits
|
- 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.
|
- Search previous suggestions before making a new one, as yours may be a duplicate.
|
||||||
* Use the following format: `[RESOURCE](LINK) - DESCRIPTION.`
|
- Make sure your list is useful before submitting. That implies it having enough content and every item a good succinct description.
|
||||||
* Keep descriptions short (<80 characters).
|
- A link back to this list from yours, so users can discover more lists, would be appreciated.
|
||||||
* End descriptions with a full stop.
|
- Make an individual pull request for each suggestion.
|
||||||
* Make an individual commit for each category.
|
- Titles should be [capitalized](http://grammar.yourdictionary.com/capitalization/rules-for-capitalization-in-titles.html).
|
||||||
* Order projects alphabetically.
|
- Use the following format: `[List Name](link)`
|
||||||
* Consolidate multiple commits.
|
- Link additions should be added to the bottom of the relevant category.
|
||||||
|
- New categories or improvements to the existing categorization are welcome.
|
||||||
|
- Check your spelling and grammar.
|
||||||
|
- Make sure your text editor is set to remove trailing whitespace.
|
||||||
|
- The pull request and commit should have a useful title.
|
||||||
|
|
||||||
## Pull Requests
|
Thank you for your suggestions!
|
||||||
* Use imperative (e.g. add instead of added/adding) in the PR title.
|
|
||||||
* Include application names, categories and a link to the open source project page in the description.
|
|
||||||
|
|
||||||
## Issues
|
|
||||||
* Discussion, questions and bug reports only.
|
|
||||||
* If you are sure software meets the guidelines, create a Pull Request (see above).
|
|
||||||
* Check spelling and grammar.
|
|
||||||
* Suggestions for improvements to existing structure are welcome.
|
|
Loading…
Reference in New Issue
Block a user