Twisted Code Review Process
- Authors: Before you get started
- Authors: Things your branch or patch must contain
- Authors: How to get your change reviewed
- Reviewers: How to review a change
- Authors: How to merge the change to trunk
All commits to Twisted's trunk must follow this review process. The only exception is for the Twisted Quotes file. There are no other exceptions!
Both authors and reviewers should be intimately familiar with all requirements on this page.
Authors: Before you get started
For the most part, we'd love for you to jump right in and start writing code! The code review process should catch any serious problems with your contribution, and the continuous integration system should catch most tricky cross-platform issues. It's easy to get too caught up in trying to do everything perfectly the first time and never get any code written, so you should usually err on the side of just trying something out rather than waiting for someone to tell you if it's OK. That being said, there are a few things that you should really be aware of before you write your first line of code:
- Make sure you have a clear idea of what work needs doing. Write down your idea first; file a ticket before you write a patch. A really good ticket will give a precise description of what needs to change and why it needs changing; it avoids giving precise details of exactly how the code needs to change, because the patch should supply those details. A really bad ticket will say "here is a patch I wrote, apply it". If you're just getting started with contributing to Twisted, it would be good to find an existing ticket rather than come up with something yourself, so you have an idea how to go through the process before you start making difficult changes. You'll need to have a good description of your work for other parts of the process as well (the NEWS file, the commit message) which is another reason thinking about what you're trying to do helps.
- Note: if you're filing a bug because you noticed a regression in a current pre-release, make sure to mark it as a regression, add it to the release milestone, and to post something to the mailing list as well. It's very important for us to spot regressions before they make it into a final release, so redundant communication is better in this case!
- Try not to write too much code at once. A good change really needs to be be under 1000 lines of diff for a reviewer to be able to deal with it before getting fatigued and missing things. Really, you should be aiming for things in the neighborhood of 200 lines. This is for your benefit as well as the reviewer's; we don't want you to spend weeks on a 10,000-line monster of a feature, only to have it rejected because we're not interested in having such a feature at all.
Authors: Things your branch or patch must contain
- Code which follows the coding standard.
- 100% unit test coverage for all modified and new code (even if it didn't have tests before)
- 100% API docstring coverage for all modified and new code (even if it didn't have docs before)
- No backwards-incompatible changes. Please also be sparing when adding 'public' names to the API, as they must be supported in the future. If it can start with an underscore and not be exposed publicly, it probably should.
- Appropriate new or modified "End User" guide documentation (in the form of rst files in the docs/ directory)
- A file in all relevant "topfiles" directories describing changes which affect users (See below)
Authors: How to get your change reviewed
- There must be a bug in the Twisted bug tracker describing the desired outcome (See below).
- Note: For security issues, see Security.
- Add the "review" keyword to the ticket.
- Remove the owner field by selecting the blank option next to "Assign to".
- Alternatively, assign it to someone who has already agreed to review it.
- Write a comment with any relevant information for the reviewer.
- If you are a Twisted committer:
- Make sure your code is in a branch.
- Make sure the 'branch' field on the ticket corresponds to the branch where the code is checked in.
- Force a build of your branch. Make sure that it's green!
Reviewers: How to review a change
- Be familiar with the Twisted codebase, coding standard, and these review requirements.
- Don't be the author of the change (See below).
- Make sure that it's green! Trigger a build if it was not done yet.
- There is one caveat to this rule. If one of the tools that we use to verify the code, such as
pyflakes, causes a build to fail, but for a reason that has to do with a bug in the tool rather than a problem with the code, file the bug in the tool, and then link from the bug report to the twisted ticket where you saw the spurious failure. You can file bugs in twistedchecker here, pydoctor here, or pyflakes here. Don't block a branch on a tool bug, but also, don't let any spurious failures go without filing an appropriate bug on the relevant tool first.
- If the contributor lacks permission to create branches in the official Twisted repository on github (
twisted/twisted), you will need to push it to the official Twisted repository -- after a security review -- to cause all of the CI builders to process the branch. After verifying the change is not an attack on the CI system, use
admin/pr_as_branchto push the changes into the official Twisted repository. The remaining builds will be started and the results will eventually appear on the original PR. If new commits are pushed to the branch, repeat the process.
- There is one caveat to this rule. If one of the tools that we use to verify the code, such as
- Assign the ticket to yourself.
- Review the change, and write a detailed comment about all potential improvements to the branch (See below).
- Remove the "review" keyword from the ticket.
- Assign the ticket back to the author.
- If the change is ready for trunk, indicate so by writing "please merge" or "+1".
- Alternatively, if the author does not have commit access to trunk, merge the change for them.
Authors: How to merge the change to trunk
- Check in the GitHub PR that all tests are green (or the failed one are just unrelated/spurious failures)
- Use the GitHub merge button to merge the request, using the GitHub default commit subject, and with the standard commit format required by Twisted. See below for details.
- Alternatively, you can use the command line and merge the change into a checkout of Twisted trunk (as a merge commit, using
git merge --no-ff!) and commit it.
The commit message, when using both the GitHub button or the CLI commit, must follow this format (See below).
Merge pull request #123 from twisted/4356-branch-name-with-trac-id Author: <comma_separated_names> Reviewer: <comma_separated_names> Fixes: ticket:<ticket number> Long description (as long as you wish)
- After the change is merged wait for the buildbots for trunk to finish running.
- If there is a regression on a supported builder you should revert your merge.
- If this fix has implications for an ongoing pre-release in progress, please announce it on the mailing list so that the release manager will know. A change definitely has implications for the release process if:
- a pre-release has been issued for which there is no final release
- this ticket was a known regression and is now closed, so another pre-release should be issued
- this ticket was in the release milestone and is now closed, so another pre-release should be issued
- as part of the final review, the reviewer noticed that this is fixing something that could be considered a regression. In general, if there's any doubt, communicate to the mailing list. The mailing list is fairly low traffic, and so a little extra noise about interesting developments is much better than letting an important fix slip through the cracks. If you're not sure whether something qualifies as a regression or not, let the release manager know so they can decide.
It is now up to the authors of individual changes to write high-level descriptions for their changes. These descriptions will be aggregated into the release notes distributed with Twisted releases. If we just let each author add to the NEWS file on every commit, though, we would run into lots of spurious conflicts. To avoid this, we have come up with a scheme involving separate files for each change.
Changes must be accompanied by an entry in at least one
topfiles directory. There are
topfiles directories for each subproject (eg. https://github.com/twisted/twisted/tree/trunk/twisted/names/topfiles, https://github.com/twisted/twisted/tree/trunk/twisted/words/topfiles), and one root directory (https://github.com/twisted/twisted/tree/trunk/twisted/topfiles) for core Twisted changes. If a change affects multiple areas of Twisted, then each affected area can have a topfiles entry to detail the relevant changes. An entry must be a file named
<ticket number>.<change type> (eg.
1234.bugfix). You should replace
<ticket number> with the ticket number which is being resolved by the change (if multiple tickets are resolved, multiple files with the same contents should be added). The
<change type> extension is replaced by one of the following literal strings:
|feature||Tickets which are adding a new feature|
|bugfix||Tickets which are fixing a bug|
|doc||Tickets primarily about fixing or improving documentation (any variety)|
|removal||Tickets which are deprecating something or removing something which was already deprecated|
|misc||Tickets which are very minor and not worth summarizing outside of the git changelog. These should be empty (their contents will be ignored)|
To get a sense of how the text in these files is presented to users, take a look at the real overall news file. The goal when writing the content for one of these files is to produce text that will fit well into the overall news files.
Here are a few which should help you write good news fragments:
- The entry SHOULD contain a high-level description of the change suitable for end users.
- When the changes touch Python code, the grammatical subject of the sentence SHOULD be a Python class/method/function/interface/variable/etc, and the verb SHOULD be something that the object does. The verb MAY be prefixed with "now".
- For bugfix, it MAY contain a reference to the version in which the bug was introduced.
Here are some examples. Check out the root
NEWS file for more inspiration.:
twisted.protocols.amp now raises InvalidSignature when bad arguments are passed to Command.makeArguments
The new module twisted.internet.endpoints provides an interface for specifying address families separately from socket types.
twisted.internet.ssl.Certificate(...).getPublicKey().keyHash() now produces a stable value regardless of OpenSSL version. Unfortunately this means that it is different than the value produced by older Twisted versions.
twisted.names.secondary.SecondaryAuthority can now answer queries again (broken since 13.2.0).
The SSL server string endpoint parser (twisted.internet.endpoints.serverFromString) now constructs endpoints which, by default, disable the insecure SSLv3 protocol.
twisted.trial.util.findObject is now deprecated.
twisted.conch.insults.colors is now deprecated in favor of twisted.conch.insults.helper.
twisted.runner.procmon.ProcessMonitor's active, consistency, and consistencyDelay attributes are now deprecated.
twisted.internet.interfaces.IReactorTime.cancelCallLater, deprecated since Twisted 2.5, has been removed.
Support for versions of pyOpenSSL older than 0.10 has been removed.
The documentation for twisted.internet.defer.DeferredSemaphore now describes the actual usage for `limit` and `tokens` instance attributes.
The docstring for twisted.conch.ssh.userauth.SSHUserAuthClient is now clearer on how the preferredOrder instance variable is handled.
twisted.mail.alias now has full API documentation.
The howto document page of Deferred now has documentation about cancellation.
You don't need to worry about newlines in the file; the contents will be rewrapped when added to the NEWS files.
Filing bugs and writing review requests
Tickets should be described well enough that the change is already justified and the new code should be easy enough to read that further explanations aren't necessary to understand it, but sometimes diffs themselves can be more difficult to read than either the old or new state of the code, so comments like the implementation of foo moved from bar.py to baz.py can sometimes make a reviewer's job easier.
If you're a committer, please always make sure the "branch" field is current and force a build; this helps decrease review latency if the reviewer can see the diff and build results from the convenient links at the top of the ticket without waiting.
Who can review?
Changes must be reviewed by a developer other than the author of the changes. If changes are paired on, a third party must review them. If changes constitute the work of several people who worked independently, a non-author must review them.
A reviewer need not necessarily be familiar with the specific area of Twisted being changed, but he or she should feel confident in his or her abilities to spot problems in the change.
Twisted committers may review anyone's tickets; those submitted by other committers or those submitted by non-committer contributors. If a non-committer contributor submits a ticket that is acceptable to merge, it is the committer's responsibility to commit and merge the branch. When a committer reviews a ticket, they are responsible if there are any problems with the review.
Non-committer contributors may review tickets which committers have submitted. When a non-committer views review queue, it will ghost the rows submitted by other non-committers so they know not to review those. When a non-committer does a passing review, the committer may accept it and land their change, but they are then responsible for the adequacy of the review. So, if a non-committer does a review you feel might be incomplete, put it back into review and explain what they might have missed - this kind of reviewing-the-review is important to make sure that more people learn how to do reviews well!
How to be a good reviewer
First, make sure all of the obvious things are accounted for. Check the "Things your branch or patch must contain" list above, and make sure each point applies to the branch. Use pyflakes to check the basic quality of the code. The following command will check all the files modified and added by a branch merge:
git diff --staged --name-only | xargs pyflakes
A reviewer may reject a change for various reasons, many of which are hard to quantify. Basically, use your best judgement, and don't be afraid to point out problems which don't fit into the list of branch requirements laid out in this document.
Here are some extra things to consider while reviewing a change:
- Is the code written in a straightforward manner which will allow it to be easily maintained in the future, possibly by a developer other than the author?
- If it introduces a new feature, is that feature generally useful and have its long term implications been considered and accounted for?
- Will it result in confusion to application developers?
- Does it encourage application code using it to be well factored and easily testable?
- Is it similar to any existing feature offered by Twisted, such that it might make sense as an extension or modification to some other piece of code, rather than an entirely new functional unit?
- Does it require new documentation and examples?
When you're done with the review, always say what the next step should be: for example, if the author is a committer, can they commit after making a few minor fixes? If your review feedback is more substantial, should they re-submit for another review?
If you are officially "doing a review" - in other words, removing the review keyword - please make sure you do a complete review and look for all of these things, so that the author has as much feedback as possible to work with while their ticket is out of the review state. If you don't have time to do a complete review, and you just notice one or two things about the ticket, just make a comment to help the future reviewer, and don't remove the review keyword, so another reviewer might have a look. For example, say, "I just checked for a news file and I noticed there wasn't one", or, "I saw some trailing whitespace in these methods". If you remove the review keyword, you may substantially increase the amount of time that the author has to wait for a real, comprehensive review, which is very frustrating.
The commit message
Several tools exist which parse commit messages to trunk, so the Author, Reviewer, and Fixes lines should conform to this format exactly. Multiple Fixes lines will close multiple tickets. Refs may also be used to attach the commit message to another ticket which is not being closed. The commit message should also describe the change being made in a modest amount of detail.
Reverting a change
If a change set somehow introduces a test suite regression or is otherwise found to be undesirable, it is to be reverted. Any developer may revert a commit which introduces a test suite regression on a supported platform. The revert message should be as explicit as possible. If it's a failure, put the message of the error in the commit message, possibly with the identifier of the buildbot slave. If there are too many failures, it can be put in the tracker, with a reference in the message. Use the "Reopens" tag to automatically reopen the ticket:
Revert r<revision number>: Brief description A description of the problem, or a traceback if pertinent Reopens: ticket:<ticket number>
Reverted branches are to be reviewed again before being merged.