[tor-bugs] #12882 [Onionoo]: Logging Framework

[Tor Bug Tracker & Wiki]

#12882: Logging Framework
-----------------------------+--------------------------
     Reporter:  iwakeh       |      Owner:  iwakeh
         Type:  enhancement  |     Status:  needs_review
     Priority:  normal       |  Milestone:
    Component:  Onionoo      |    Version:
   Resolution:               |   Keywords:
Actual Points:               |  Parent ID:
       Points:               |
-----------------------------+--------------------------

Comment (by karsten):

 Oh wow, that's quite a patch.  Lots of good stuff in it, but we'll need to
 tweak it before we can apply it.  Let me take this opportunity to start a
 "Contributor Guide" (this is written in Markdown, because I want to commit
 this text to a Markdown file later).  Want to tweak this patch and push
 changes to a public Git repository somewhere?  Also feel free to comment
 on the Contributor Guide.

 # Contributor Guide

 This guide is meant for people who want to contribute patches to Onionoo.

 ## Patch format

 Format your patches using `git format-patch` if you want to submit just a
 single, small commit.
 If you want to submit more than one commit, push your changes to a public
 Git repository somewhere that can be pulled from.

 ## Whitespace conventions

 Whitespace conventions are important, because whitespace changes bloat
 patches and make them harder to review.
 If we all agree on the same whitespace conventions, the only changes to
 review are actually meaningful changes.
 If you need to make whitespace changes, because files did not conform to
 whitespace conventions before, do these changes in one or more separate
 commits that contain nothing else than whitespace changes.

 The following whitespace conventions apply:

  - Maximum line width is 74 characters.  Why 74?  Because it looks pretty
 in vim in a 80-character terminal with line numbers turned on.
  - Full sentences are followed by a period and two spaces.  An exception
 to this rule are sentences in markup files like Markdown; in this case,
 each sentence should start with a newline, so that a change in one
 sentence doesn't cause changes to all subsequent sentences.  An exception
 to this exception are multiple sentences in a single bullet point.
  - Indentations use two spaces, no tabs.  Continuations use four spaces.
  - Attributes and methods are typically separated by two newlines.  An
 exception are attributes with getters and setters which can be written
 without separating newlines.
  - All source files end with two newlines.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/12882#comment:7>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online