Skip to content
Snippets Groups Projects

RelaySearch

Last edited by Alexander Færøy

Relay Search Development

Quick Links

Projects

  • 2017-01 to 2017-03: org/sponsors/SponsorX tasks 3.3. Improve all usability issues of Relay Search (then known as Atlas) that are classified as High priority or above in the issue tracker as long as they are within scope and reported at least six months before the end of the award.

Hacking

If you would like to contribute to Relay Search, you can get started by cloning the Git repository from the location in the quick links section at the top of this page. Open index.html in your web browser and you'll find Relay Search running. There is no build process, the sources in the Git are exactly what are deployed on the Tor Project's instance. While Relay Search is running in your browser, it will make calls to the https://onionoo.torproject.org/ backend and so does require network access.

By default, new tickets are assigned to the metrics-team metauser. If you are working on an issue, please take ownership of it via the Trac and set the status to accepted. This helps us to avoid duplication of effort.

Development of Relay Search is managed in Git and the preferred means of submitting patches is via a link to the output of https://linux.die.net/man/1/git-format-patch. If you would like to use GitHub, you can create URLs for this as:

https://github.com/<username>/relay-search/compare/<branch-with-fixes>.patch

If you wish to contribute to Relay Search anonymously through the cypherpunks account, it is acceptable to attach the patches to the ticket.

Please use well-formatted and well-explained commit messages. You can find guidelines and suggestions for commit messages here: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

All patches must address tickets that are filed in the Trac, and you can find a list of open tickets below. If you find an issue that you would like to produce a patch for that doesn't have a ticket, create a new ticket and set the component to "Metrics/Relay Search". When you link a patch from the Trac, set the ticket status to "needs_review". Once the patch has been reviewed, it will either be set to "merge_ready" or it will be merged straight away and the ticket closed as "fixed". If the reviewer finds that the patch needs more work, the status will be set to "needs_revision".

Anyone may contribute to reviews in the comments, but please do not set tickets to "merge_ready" on patches unless you are already a well known member of the Metrics team. Your comments will be seen by the reviewer and taken into account.

All Tasks in Trac

Active Tasks

[[TicketQuery(component=Metrics/Relay Search,status=!closed,format=table,order=changetime,desc=true,col=id|summary|status|priority|severity|reporter|changetime,max=50)]]

Completed Tasks

[[TicketQuery(component=Metrics/Relay Search,status=closed,format=table,order=changetime,desc=true,col=id|summary|priority|severity|reporter|changetime,max=50)]]

Contact

(If you get no response on IRC, you can highlight irl, the current Relay Search maintainer)

Comments

    Please register or sign in to add a comment.