#10201: Developer's Guide: add Stein's blog post on reviewing
-----------------------------+----------------------------------------------
Reporter: jsrn | Owner: mvngu
Type: enhancement | Status: needs_work
Priority: minor | Milestone: sage-4.6.1
Component: documentation | Keywords:
Author: jsrn | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Comment(by jsrn):
Replying to [comment:2 mvngu]:
> Better yet is to directly add William's writings to the Developer's
Guide. That's better than providing a link to his blog post. Hence, I'm
moving this ticket to "needs work".
I don't immediately agree. I think that would muddle up the instructions
on reviewing too much; we already have two descriptions which are referred
to as more or less mandatory reading (the one in the Walkthrough and the
one in the Trac manual). I remember how much work it felt like, having to
read many pages of guide before being able to review a single patch.
Having a third covering almost the same is way too much. That's why I
added William's blog as a link, which gives it an air of "this is how
someone else does it as well, which you might read now or once you've
tried reviewing a few times.".
I think William's blog entry contained three important additions to what
is already in the documentation:
- A better explanation of "why should you review"
- A (brief) guide on how William does it, what he considers important and
so on, giving a second aspect of Sage and reviewing.
- Ideas on how to automate and improve the process for reviewing many
tickets.
So I think the best alternative to linking to the blog entry is to clean
up the guide to have one - more comprehensive - description of the
reviewing process, compiled from the three we have now. This should
contain all the goodies of all three, eatly written into one and
structured into how to do it the first time, and how to later streamline
the process when reviewing many patches. This would probably require a
major restructuring of at least the Walkthrough and the Trac Manual,
though.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10201#comment:4>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
