Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.67 KB
Raw

General Guidelines for Contributing

  • Important: Make sure you are developing off of the onionscan-0.3 branch - this is an experimental branch aimed at testing new features before rollng them into a release.
  • Issues are the best place for design discussions and questions.
  • Documentation and Tests are always welcome.
  • When submitting a PR tests are automatically run with Travis-CI please ensure that your code does not break this integration.

What should I work on?

Check out the Help Wanted for projects that will likely be the easiest for newcomers

Issues marked idea/ needs design should begin with a document linked from the issue to allow input as these are likely to have the biggest impact on OnionScan's overall architecture.

If in doubt, you can always contact @s-rah

What if I have a new idea?

Awesome. You can generally either add an issue if it is still in the thought stages or a PR if you have code. If you are unsure about whether a new idea is suitable for OnionScan please open an issue. Generally the following are always encouraged:

  • New identifier correlations (past examples: email addresses, cryptocurrency id's)
  • New analytics techniques (past examples: ssh key correlations, image fingerprinting)
  • New protocols (that are likely being used by onion services, past examples: bitcoin, irc, ssh)
  • New Miconfigurations/Exploits (past examples: mod_status)
  • Bug fixes
  • Usability Improvements
  • Tests and Documentation

If in doubt, you can always contact @s-rah