Changes between Version 36 and Version 37 of Patches

Timestamp:

2021-04-09T12:19:33Z (3 years ago)

Author:

exarkun

Comment:

Describe the GitHub?-driven review process

Patches

@@ -16 +16 @@
 Now, hack at Tahoe-LAFS!
 
-Once you think you have solved the issue run the test suite with `tox`. This ensures that you didn't accidentally break something while working on your patch.
+We encourage you to use test-driven development [https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToWriteTests and write your own tests] when hacking on Tahoe-LAFS.  This method can help you create better factored, better tested, less buggy code.
 
-Now that all of the existing unit tests pass, [https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToWriteTests write your own tests] for the ticket if they don't already exist, and make sure that they pass. Also ensure that `tox -e codechecks` finds no errors or warnings.
+Once you think you have solved the issue run the test suite with `tox`. This ensures that you didn't accidentally break something while working on your patch and will run your new tests, too.
 
-Finally, push your branch to Github and [https://help.github.com/articles/creating-a-pull-request open a pull request]. Please add the keyword `review-needed` to the ticket and add a link to the pull request. If you had trouble writing unit tests for your patch, don't worry. Submit the pull request anyway and add the keyword `test-needed` to the ticket.
+You can also use `tox -e codechecks` and `tox -e typechecks` to check for other kinds of errors.
 
+Finally, push your branch to Github and [https://help.github.com/articles/creating-a-pull-request open a pull request]. Use the [https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review GitHub "request review"] feature to let the team know your PR is ready for a code review.  You should usually request a review from "tahoe-committers" but you can request a review from a specific developer instead if you have good reason to want their review specifically.  If you had trouble with any part of your patch -- don't worry!  Submit the pull request for review anyway and leave a comment describing the area you'd like help with.
 
 = Design reviews =