diff --git a/PatchReviewProcess.md b/PatchReviewProcess.md index 9bddbf1..fa3fbfb 100644 --- a/PatchReviewProcess.md +++ b/PatchReviewProcess.md @@ -23,7 +23,7 @@ Here is the overall process for patch review. For technical tips, see below. 2. You can read everything without registering, but to add comments or change tickets you have to be logged in. Registering is easy -- click the "Register" link at the top right of the page. 3. Read tickets until you find one that you can review. 4. (optional) Expand "modify ticket" and click "accept", then submit changes. This marks you as the person reviewing this patch. If you don't want to commit to this then you can skip this step. - 5. Read the patch until you understand the docs, tests, code and comments in it. You can use the "Browse source" button at the top of the page to read the current versions of the files that the patch changes. + 5. Read the patch until you understand the docs, tests, code and comments in it. (You can use the "Browse source" button at the top of the page to read the current versions of the files that the patch changes.) Post comments on the trac ticket as you go. If there's something good or bad in the patch you're reviewing, then you'll know it when you see it. 1. If you can't understand the patch after spending some time on it, then say so in a comment on the ticket! This might mean that we need to add documentation or comments or to refactor the code. On the other hand, it might just be that you don't have enough context to understand the code. That's okay too, so go ahead and speak up. 2. Check whether every feature or bugfix in the patch has an accompanying test in the patch. 3. If you find errors or omissions in the docs, tests, code or comments then write that down in the ticket, remove the `review-needed` keyword from the keywords, and assign the ticket to someone other than yourself. (Assign it to the original author of the patch, or someone who seems likely to fix the patch, or "nobody".) @@ -42,6 +42,8 @@ A few simple suggestions: ## Ticket attachment links +NOTE: we've moved from darcs to git, and we've started using github for some things and continuing to use trac for others. So the following is partially obsolete and needs to be rewritten. + Attachments in a ticket have two links, a name, which points to an html page with prettification, and a raw download link. You can save the download link (such as by `wget`) and use `darcs apply` to configure your repository to test a particular patch. Note that you do not *have* to apply a patch to your local repository or test it in order to review it—often just reading the prettified version on the web is sufficient. For the #1149 ticket, for example, there are two links for the attachment named "test-for-webopen.darcs.patch":