Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
s-rah authored Oct 4, 2016
1 parent 7068ce8 commit 9c88aa9
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# General Guidelines for Contributing

* **Important:** Make sure you are developing off of the `onionscan-0.2` branch - it has many new features that make adding new code much easier.
* 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 [Hacktoberfest](https://github.com/s-rah/onionscan/issues?q=is%3Aissue+is%3Aopen+label%3AHacktoberfest) label for projects that will likely be the easiest for newcomers. [Help Wanted](https://github.com/s-rah/onionscan/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) is also good to check for larger tasks.

Issues marked [idea/ needs design](https://github.com/s-rah/onionscan/issues?q=is%3Aissue+is%3Aopen+label%3A%22idea+%2F+needs+design%22) 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

0 comments on commit 9c88aa9

Please sign in to comment.