Changes between Version 6 and Version 7 of doc/Atlas


Ignore:
Timestamp:
Dec 17, 2017, 6:59:54 PM (2 years ago)
Author:
irl
Comment:

Moved to org/teams/MetricsTeam/RelaySearch

Legend:

Unmodified
Added
Removed
Modified
  • doc/Atlas

    v6 v7  
    1 = Relay Search Development =
    2 
    3 == Quick Links ==
    4 
    5  * Homepage: https://atlas.torproject.org/
    6  * Onion Service: http://52g5y5karruvc7bz.onion/
    7  * Source Browser: https://gitweb.torproject.org/atlas.git/
    8  * `git clone https://git.torproject.org/atlas.git`
    9 
    10 == Projects ==
    11 
    12  * 2017-01 to 2017-03: [[org/sponsors/SponsorX|Sponsor X]] 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.
    13 
    14 == Hacking ==
    15 
    16 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/|Onionoo]] backend and so does require network access.
    17 
    18 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.
    19 
    20 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|git-format-patch]]. If you would like to use GitHub, you can create URLs for this as:
    21 
    22 {{{
    23 https://github.com/<username>/relay-search/compare/<branch-with-fixes>.patch
    24 }}}
    25 
    26 If you wish to contribute to Relay Search anonymously through the ''cypherpunks'' account, it is acceptable to attach the patches to the ticket.
    27 
    28 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
    29 
    30 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".
    31 
    32 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.
    33 
    34 == All Tasks in Trac ==
    35 
    36 === Active Tasks ===
    37 
    38 [[TicketQuery(component=Metrics/Relay Search,status=!closed,format=table,order=changetime,desc=true,col=id|summary|status|priority|severity|reporter|changetime,max=50)]]
    39 
    40 === Completed Tasks ===
    41 
    42 [[TicketQuery(component=Metrics/Relay Search,status=closed,format=table,order=changetime,desc=true,col=id|summary|priority|severity|reporter|changetime,max=50)]]
    43 
    44 == Contact ==
    45 
    46 * User mailing list: https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays
    47 * User IRC channel: #tor on irc.oftc.net
    48 * Development mailing list: https://lists.torproject.org/cgi-bin/mailman/listinfo/metrics-team
    49 * Development IRC channel: #tor-dev on irc.oftc.net
    50 
    51 (If you get no response on IRC, you can highlight ''irl'', the current Relay Search maintainer)
     1This page has moved to [[org/teams/MetricsTeam/RelaySearch]].