nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-24 04:13:28 +01:00
Code Issues Packages Projects Releases Wiki Activity
c390f1dd7e
tor/doc/HACKING
History
teor c390f1dd7e doc: Add a new Travis CI cron job when there's a new maint branch 
Part of 28453.
2019-05-30 09:02:13 -04:00
..
android Fix spelling mistakes corresponding to ticket #23650 2018-02-07 10:41:57 -05:00
CodeStructure.md Add an initial CodeStructure.md file to doc/HACKING. 2018-07-10 11:01:09 -04:00
CodingStandards.md Coding Standards: Document how to find git commits 2019-04-23 10:03:18 +10:00
CodingStandardsRust.md Removed the use of expect from CodingStandardsRust 2019-04-03 08:32:10 -04:00
Fuzzing.md Small fixes to fuzzing documentation. 2017-02-24 10:57:58 -05:00
GettingStarted.md doc: make introduction paragraph point to correct data 2017-09-15 08:18:37 -04:00
GettingStartedRust.md Merge branch 'maint-0.3.2' into maint-0.3.3 2018-08-16 08:35:27 -04:00
HelpfulTools.md Improve failure message from check-best-practices 2019-03-13 09:27:29 -04:00
HowToReview.md Mention even more about changes files in doc/HACKING 2017-09-22 15:14:36 -04:00
Maintaining.md fix some of the typos in Maintaining.md 2019-02-17 16:55:55 -05:00
Module.md Stop mentioning src/or and src/common in doc/HACKING 2018-07-10 11:03:45 -04:00
README.1st.md added some markdown formatting 2015-11-05 09:13:53 -05:00
ReleasingTor.md doc: Add a new Travis CI cron job when there's a new maint branch 2019-05-30 09:02:13 -04:00
Tracing.md Fix everything that previously referred to src/or 2018-07-05 17:15:50 -04:00
WritingTests.md Mention that we require Python 2.7 or newer 2018-09-24 11:25:33 -04:00

README.1st.md

In this directory

This directory has helpful information about what you need to know to hack on Tor!

First, read GettingStarted.md to learn how to get a start in Tor development.

If you've decided to write a patch, CodingStandards.txt will give you a bunch of information about how we structure our code.

It's important to get code right! Reading WritingTests.md will tell you how to write and run tests in the Tor codebase.

There are a bunch of other programs we use to help maintain and develop the codebase: HelpfulTools.md can tell you how to use them with Tor.

If it's your job to put out Tor releases, see ReleasingTor.md so that you don't miss any steps!

For full information on how Tor is supposed to work, look at the files in https://gitweb.torproject.org/torspec.git/tree.

For an explanation of how to change Tor's design to work differently, look at https://gitweb.torproject.org/torspec.git/blob_plain/HEAD:/proposals/001-process.txt.

For the latest version of the code, get a copy of git, and

git clone https://git.torproject.org/git/tor

We talk about Tor on the tor-talk mailing list. Design proposals and discussion belong on the tor-dev mailing list. We hang around on irc.oftc.net, with general discussion happening on #tor and development happening on #tor-dev.

The other files in this HACKING directory may also be useful as you get started working with Tor.

Happy hacking!

XXXXX also describe

doc/HACKING/WritingTests.md

torguts.git

torspec.git

The design paper

freehaven.net/anonbib

XXXX describe these and add links.