awesome/tor
1
0
Fork 0
mirror of https://github.com/ajvb/awesome-tor.git synced 2024-11-13 11:17:12 -05:00
Code Activity
tor/CONTRIBUTING.md
Meitar M 76b475b14c
Reorganize, make a first pass at awesome-list style guide compliance. 
This commit makes massive changes to the list organization. Instead of
categorizing the projects as "Tor Project's Projects" or not, mainly,
which was one gigantic and growing list of current and outdated
projects, the line items are categorized by their purpose or function.
The goal is to make the list more useful for someone who is unfamiliar
with Tor and wants to know which tool or project is the most relevant to
their use case.

In addition, this commit adds the following Tor-based tools:

* Ricochet, a Tor Onion service-based Jabber messenger.
* Whonix, a GNU/Linux distribution that torifies everything by default.
* OnionScan, a security tool for alerting on Onion service misconfigs.
* Vanguards, an Onion service entry guard attack mitigation script.
* tor.rb, a Ruby library for interacting with Tor.

This commit further adds a License heading, and edits many list items
for conformance with the awesome-list style guide. Namely, this means
"a" and "an" prepositions have been dropped, project names are removed
from the project line item description, periods are added to the end of
line item descriptions, headings are moved to level one, a
`CONTRIBUTING.md` file has been added, and so on.
2018-08-08 15:38:57 -04:00

2.9 KiB
Raw Blame History

Contribution Guidelines

Your pull request should have a useful title. Please carefully read everything in Adding to this list.

Table of Contents

Adding to this list

Please ensure your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Make sure the item you are adding is useful (and, you know, awesome) before submitting.
  • Make an individual pull request for each suggestion.
  • Use title-casing (AP style).
  • Use the following format: [Item Name](link)
  • 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.
  • The body of your commit message should contain a link to the repository.

Thank you for your suggestions!

Adding something to an awesome list

If you have something awesome to contribute to an awesome list, this is how you do it.

You'll need a GitHub account!

  1. Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome
  2. Click on the readme.md file: Step 2 Click on Readme.md
  3. Now click on the edit icon. Step 3 - Click on Edit
  4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use GitHub Flavored Markdown. Step 4 - Edit the file
  5. Say why you're proposing the changes, and then click on "Propose file change". Step 5 - Propose Changes
  6. Submit the pull request!

Updating your Pull Request

Sometimes, a maintainer of this list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-* list guidelines. Here is a write up on how to change a Pull Request, and the different ways you can do that.