[tor-bugs] #8948 [Tor]: Write a "code review guidelines" page

[Tor Bug Tracker & Wiki]

#8948: Write a "code review guidelines" page
-------------------------+--------------------------------------------------
 Reporter:  nickm        |          Owner:                    
     Type:  enhancement  |         Status:  new               
 Priority:  normal       |      Milestone:  Tor: 0.2.5.x-final
Component:  Tor          |        Version:                    
 Keywords:               |         Parent:                    
   Points:               |   Actualpoints:                    
-------------------------+--------------------------------------------------

Comment(by atagar):

 I'm surprised that you consider that to be a good example. If I was a
 contributor faced with a page saying "Both authors and reviewers should be
 intimately familiar with all requirements on this page." followed by that
 many requirements I'd be reluctant to contribute.

 This isn't to say that twisted's requirements are at all bad, just that
 it's a lot to expect first time contributors to follow. For stem I try to
 make contributing damn easy. If a developer runs...

 {{{
 run_tests.py --all
 }}}

 ... and it passes then they're good to send their change out for code
 review. That runs all the tests including style checkers and pyflakes.

 In short, if tor has requirements that you want followed prior to sending
 code reviews then imho it should be a simple make target, not a wall of
 text.

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