Opened 5 months ago

Last modified 2 months ago

#33589 assigned task

Copy Outreachy developer advice to the wiki or doc/HACKING

Reported by: teor Owned by: ahf
Priority: Medium Milestone: Tor: 0.4.4.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: 044-should, docshackathon, postfreeze-ok
Cc: Actual Points:
Parent ID: Points: 0.5
Reviewer: Sponsor:

Description

We gave Outreachy interns a bunch of info about how to get started developing Tor. And how we communicate.

We should use this info to update the wiki or doc/HACKING.

Child Tickets

Change History (5)

comment:2 Changed 5 months ago 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
  1. Clone tor using git: https://github.com/torproject/tor
  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: https://github.com/torproject/chutney
  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 the tor or chutney GitHub repository

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@….

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.

Anyone is free to work on any existing ticket. If there hasn't been much activity on the ticket in the last few weeks,

then you're welcome to work on it. If no-one is assigned to the ticket, you can assign it to yourself. If the ticket is assigned to someone else, please ask them if they are still working on it, by writing a comment on the ticket.

There are lots of projects on our Trac instance, so we don't read all the comments on all the tickets. Please CC teor, ahf, and nickm on tickets if you'd like us to answer questions.

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.

If you can, use an IRC bouncer, so you don't miss any replies.

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.

Last edited 5 months ago by teor (previous) (diff)

comment:3 Changed 5 months ago by gaba

Keywords: docshackathon added

comment:4 Changed 2 months ago by nickm

Keywords: postfreeze-ok added

Mark tickets which are important or safe enough to look at post-freeze for 0.4.4.

comment:5 Changed 2 months ago by nickm

Owner: set to ahf
Status: newassigned
Note: See TracTickets for help on using tickets.