= 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
- Metrics Team Page
- coding style guides
- depending on what interests you most various protocols, e.g. TorSpec and Onionoo
- Get up-to-date with tools as well as the languages used in the area you're interested in, see guides.
Typical Work-flow
- Pick a task from the
metrics-help
tagged ones (see [#Wheretohelp table]). - Analyze the problem and add a comment containing the (short) analysis and proposed solution.
- We'll discuss the solution with you to make sure things fit before too much code is written.
- Provide a patch (see guide doc).
- Finally the review and revision //cycle//.
- patch merged to Metrics code base.
Where to help
- Run an independent server instance of one of Metrics products, like
-
Use metrics-lib for analyzing Tor data.
-
Enter bugs or feature requests by creating a new Metrics ticket.
-
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)]]