[tor-bugs] #33589 [Core Tor/Tor]: Copy Outreachy developer advice to the wiki or doc/HACKING

[Tor Bug Tracker & Wiki]

#33589: Copy Outreachy developer advice to the wiki or doc/HACKING
--------------------------+------------------------------------
 Reporter:  teor          |          Owner:  (none)
     Type:  task          |         Status:  new
 Priority:  Medium        |      Milestone:  Tor: 0.4.4.x-final
Component:  Core Tor/Tor  |        Version:
 Severity:  Normal        |     Resolution:
 Keywords:  044-should    |  Actual Points:
Parent ID:                |         Points:  0.5
 Reviewer:                |        Sponsor:
--------------------------+------------------------------------

Comment (by teor):

 The outreachy docs are available to logged-in interns, mentors, or
 coordinators here:
 https://www.outreachy.org/outreachy-may-2020-internship-round/communities
 /tor-project/improve-tor-relay-ipv6-network-support/cfp/

 Here's a copy of the most useful bits:

 System Requirements

 A Unix-based Operating System. Our developers have successfully used:
 * Linux
 * macOS
 * BSDs
 * Windows 10 with Windows Subsystem for Linux

 Each OS has different CPU, RAM, and free disk space requirements. See
 below for details. If you can compile tor, run its unit tests, and run
 chutney (see the Getting Started instructions), your device can be used to
 do this project.

 Linux, macOS, BSDs
 * A 32-bit CPU, 1 GHz dual-core
 * 2 GB RAM, 4 GB recommended for macOS
 * 20 GB free hard drive space

 Windows 10 with Windows Subsystem for Linux
 * A 64-bit CPU, 1.5 GHz dual-core
 * 4 GB RAM
 * 30 GB free hard drive space

 Getting started with tor development:
 1. Clone tor using git
 2. Build tor from source
 3. Run the tor unit tests using "make check". Let us know if they fail,
 and we'll help fix them
 4. Clone chutney using git. Chutney is a tor integration test tool
 5. Go to the tor directory, and run the tor integration tests using "make
 test-network". Let us know if they fail, and we'll help fix them
 6. Make sure you have a GitHub account, so you can submit pull requests to
 tor's GitHub repository

 (With links to tor git, chutney git, and torproject GitHub.)

 How to ask for help:

 Join us on OFTC IRC network. It might take a few hours to get an answer,
 so please leave your IRC client open! Email us at tor-
 dev at lists.torproject.org.

 Communication channels"

 Tor Project Trac:

     This ticket tracker is used to work on tasks. There's no way to
 introduce yourself.

     We make pull requests on GitHub at https://github.com/torproject/tor
 so our comtinuous integration (CI) will run our tests.
     Put the Trac ticket in "needs_review" status when you want to submit a
 pull request.
     If CI fails, that's ok, it happens to all of us! Ask for help on IRC
 or the tor-dev mailing list.

     If you create new tickets, put them in the "Core Tor/Tor" component,
 with the "Tor: 0.4.4.x-final" milestone. We will triage new tickets, and
 fill in the other fields.
     Follow this link to join this project's public chat.

     Create an account and log in.

     Ask for Trac "user" permissions on the mailing list or IRC. User
 permissions let you reply to ticket comments, modify ticket statuses, and
 view ticket queries.


 IRC:

     Use a paste bin like https://paste.debian.net/ for posting source
 code, logs, or other long messages.

     Wait at least a day before re-posting the same question in the same
 channel.

     Different channels are for different topics. Most people are in
 multiple channels. Don't post the same question to multiple channels
 (unless someone tells you to use another channel).

     Don't post in the bot channels: #tor-bots and #tor-ci.
     Follow this link to join this project's public chat. If you are asked
 for username, pick any username! You will not need a password to join this
 chat.

     Please join the #tor-dev channel, and introduce yourself. You might
 need to wait a few hours for a reply, we're all in different time zones!

     We have meetings in #tor-meeting and #tor-meeting2. If you want to
 join a meeting, please introduce yourself at the meeting time.

     The #tor-bots channel has ticket, git, network health, and Jenkins
 continuous integration (CI) updates. The #tor-ci channel has Travis and
 Appveyor CI updates. Please don't post in these channels.

 the tor-dev mailing list

     You can use this list to ask about tasks you are interested in, or to
 get help if you get stuck.

     Most people on this list use the "Interleaved" reply style:
     https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

     You aren't expected to Cc your mentor or the software maintainer.
     Follow this link to join this project's public chat.

     Subscribe using an email address.

     Feel free to use a nickname or handle as your name.

     Introducing yourself is optional.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/33589#comment:2>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online