mirror of
https://github.com/jivoi/awesome-osint.git
synced 2024-10-01 01:25:40 -04:00
23 lines
987 B
Markdown
23 lines
987 B
Markdown
|
# 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*.
|
||
|
|
|
||
|
|
## Commits
|
||
|
|
* Search previous suggestions before making a new one.
|
||
|
|
* Use the following format: `[RESOURCE](LINK) - DESCRIPTION.`
|
||
|
|
* Keep descriptions short (<80 characters).
|
||
|
|
* End descriptions with a full stop.
|
||
|
|
* Make an individual commit for each category.
|
||
|
|
* Order projects alphabetically.
|
||
|
|
* Consolidate multiple commits.
|
||
|
|
|
||
|
|
## Pull Requests
|
||
|
|
* 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.
|