|
|
|
|
|
|
|
|
|
|
|
|
|
|
= Volunteering and Contributing to Metrics
|
|
|
The Metrics Team supports a growing codebase for maintaining and analyzing data for an also growing number of data sources. Thus there are limited resources available for supporting projects outside the immediate scope.
|
|
|
|
|
|
This means on one hand //help wanted// and on the other that we cannot help volunteers learn how to help us.
|
|
|
So we compiled a few steps below what we think help a volunteer getting started smoothly.
|
|
|
|
|
|
## How to contribute
|
|
|
### Preparation
|
|
|
Read through the available documentation and take a look at the metrics web sites in order to get an idea what is done here. Starting points:
|
|
|
* [FAQs](./org/teams/MetricsTeam/Documentation)
|
|
|
* [Metrics Team Page](./org/teams/MetricsTeam)
|
|
|
* coding style [guides](./org/teams/MetricsTeam/Documentation#GuideDocuments)
|
|
|
* depending on what interests you most various protocols, e.g. [TorSpec](https://gitweb.torproject.org/torspec.git/) and [Onionoo](http://onionoo.torproject.org/protocol.html)
|
|
|
* Get up-to-date with tools as well as the languages used in the area you're interested in, see [guides](./org/teams/MetricsTeam/Documentation#GuideDocuments).
|
|
|
|
|
|
### Typical Work-flow
|
|
|
1. Pick a task from the `metrics-help` tagged ones (see [#Wheretohelp table]).
|
|
|
1. Analyze the problem and add a comment containing the (short) analysis and proposed solution.
|
|
|
1. We'll discuss the solution with you to make sure things fit before too much code is written.
|
|
|
1. Provide a patch (see [guide doc](./org/teams/MetricsTeam/ContributorGuide)).
|
|
|
1. Finally the review and revision //cycle//.
|
|
|
1. patch merged to Metrics code base.
|
|
|
|
|
|
## Where to help
|
|
|
|
|
|
- Run an independent server instance of one of Metrics products, like
|
|
|
* [Onionoo releases](https://dist.torproject.org/onionoo)
|
|
|
* [CollecTor releases](https://dist.torproject.org/collector)
|
|
|
|
|
|
- Use metrics-lib for analyzing Tor data.
|
|
|
|
|
|
- Enter bugs or feature requests by creating a [new Metrics ticket](https://trac.torproject.org/projects/tor/newticket?component=Metrics).
|
|
|
|
|
|
- Help implementing open tasks. These will be tagged as `metrics-help` in trac. Here a table with open tasks:
|
|
|
[[TicketQuery(keywords=metrics-help,status=!closed,format=table,order=changetime,desc=true,col=id|summary|status|priority|severity|reporter|changetime,max=20)]]
|
|
|
|
|
|
### Sites of Metrics' products
|
|
|
* https://atlas.torproject.org
|
|
|
* https://collector.torproject.org
|
|
|
* https://exonerator.torproject.org
|
|
|
* https://metrics.torproject.org
|
|
|
* https://onionoo.torproject.org |