From 1a76dd6e54d6d95d833812a10c43e398bbac2483 Mon Sep 17 00:00:00 2001 From: daira <> Date: Thu, 8 Aug 2013 11:58:29 +0000 Subject: [PATCH] remove obsolete darcs-related info and other minor tweaks [Imported from Trac: page PatchReviewProcess, version 21] --- PatchReviewProcess.md | 33 +++++---------------------------- 1 file changed, 5 insertions(+), 28 deletions(-) diff --git a/PatchReviewProcess.md b/PatchReviewProcess.md index fa3fbfb..04e19c0 100644 --- a/PatchReviewProcess.md +++ b/PatchReviewProcess.md @@ -26,8 +26,8 @@ Here is the overall process for patch review. For technical tips, see below. 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".) - 4. If you understand the patch and find no errors or omissions then write a comment on the ticket saying that you reviewed it, remove the keyword `review-needed`, add the keyword `reviewed` and assign it to someone with repository write access (currently 'zooko', 'warner', 'davidsarah', and 'kevan'). We'll commit it to trunk. + 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 add the `test-needed` keyword if that applies. Then 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".) + 4. If you understand the patch and find no errors or omissions then write a comment on the ticket saying that you reviewed it, remove the keyword `review-needed`, add the keyword `reviewed`, and assign it to someone with repository write access (currently 'zooko', 'warner', 'daira', and 'kevan'). We'll commit it to trunk. 5. Feel good about yourself. Thank you for helping with our little project attempting to improve the world! # Advanced @@ -40,31 +40,8 @@ A few simple suggestions: 3. You don't have to be extra picky when doing patch review. The goal is just to watch out for bugs or things that would reduce the quality of the codebase. 4. Write comments about specific parts of the code. This demonstrates that you actually read it carefully enough to understand and care about parts of it, and it makes the author feel good that someone is talking about what they wrote. -## Ticket attachment links +## Using trac and github -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. +The patch you're reviewing might be given either as an attachment, or as a github pull request. If it's the latter, then it's encouraged to use line comments on github for detailed comments or questions on the code. However, you should also write a short summary of the review on the trac ticket. (Sometimes this can be as simple as "+1" if there are no issues to discuss.) -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": - - * The link with a name points here: - * The link with a download icon, here: - -The latter can be used to apply a patch, like this example shows: - -``` -$ wget 'https://tahoe-lafs.org/trac/tahoe-lafs/raw-attachment/ticket/1149/test-for-webopen.darcs.patch' ---2011-07-31 20:23:39-- http://tahoe-lafs.org/trac/tahoe-lafs/raw-attachment/ticket/1149/test-for-webopen.darcs.patch -Connecting to 127.0.0.1:8123... connected. -Proxy request sent, awaiting response... 200 Ok -Length: 18275 (18K) [text/x-diff] -Saving to: “test-for-webopen.darcs.patch” - -100%[==============================>] 18,275 21.8K/s in 0.8s - -2011-07-31 20:23:54 (21.8 KB/s) - “test-for-webopen.darcs.patch” saved [18275/18275] - -$ darcs apply test-for-webopen.darcs.patch -Finished applying... -``` \ No newline at end of file +In all cases it's recommended to apply the patch or check out the code and run the full test suite locally (using `python setup.py test` since a rebuild is usually necessary), to check that it passes. All committed code should also be free of pyflakes errors or warnings.