Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Standardizing reviews #15
Today I've seen a couple of reviews, registered and looked at the review posting process. I have a few ideas on how this can be improved.
I think that for start all reviews should be standardized. This could be done with defining some sections that would appear on every review. I think that sections on Marius's reviews are a good example. So every review would have What it does, How it does, Installation and so on.
There won't be much people that would bother with html formatting or studying a guide on how to write a good review. I think that a clear structure should be provided which means a few predefined text areas and a few predefined checkboxes, that way anyone can easily write a review.
There should be checkboxes that indicate if that particular module follows common coding practices. Something like Joel Test Score on Stack Careers (for example http://careers.stackoverflow.com/jobs/62059/senior-software-engineer-tapshield?a=52vYG4lOyA).
This way reviews will also be much easier to read and more understandable to people that are not developers.
These are just some general ideas, we can discuss in greater details if you want.
+1 but leaving freedom to reviewers. I will see good a common "standard" format for all reviews with some key points mandatory to fills up in a review, so "fast reading" will works, but also will leave space to "comments" or whatever where a reviewer has the freedom of writing what it feels about the extensión.