awesome-osint/CONTRIBUTING.md
2017-03-27 12:56:48 +03:00

987 B
Executable File

Contribution Guidelines

This is a compilation of Free and Libre Open Source Software (FLOSS). 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.