GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — Define and document a procedure for following up on reviews · Issue #1359 · python/devguide Open Labels type-featureAdditions; New content or section neededAdditions; New content or section needed DescriptionI noticed several instances in which someone (typically a reviewer) suggests a change/improvement or points out other areas affected by the same issue, but those changes are deemed out of the scope of the current PR. Even if there is consensus that these changes should take place, often no follow-up takes place. When this happens, there are usually different actors involved:
There are at least a couple of reasons why the follow-up doesn't happen:
In order to solve these issues, I suggest we adopt and document the following procedure:
The goal here is both to create a reminder and to provide context through the reference to the previous PR. Generally, the follow-up should be create when the suggestion is a defined action item. If for example the changes in the PR are "good enough" but could be better (such as when the code was optimized, but could be optimized further), and it's not clear how to make them better, then it's not always necessary to create a new follow-up issue. Click for a few real-world examplesDisclaimer: with these examples, it is not my intent to blame anyone as there is currently no defined procedure to handle this situation. These are only to illustrate the very problem that I'm suggesting we address. During a review to a PR made by Hugo, I noticed and brought up a couple of issues. Petr suggested to handle them in a separate PR (which sounds reasonable), however none of use followed up on this after the PR was merged. Three weeks ago, Nikita created a PR to document Last month, Irit moved the compiler docs from the devguide to the In this final example, Erlend created two follow-up issues based on the review comments he received on his PR, by simply copy-pasting the comments and linking to the original PR. Even though the issues have been opened for over 7 months now, they document the problems and provide context about the previous discussions. Activity
MetadataMetadataAssigneesLabelstype-featureAdditions; New content or section neededAdditions; New content or section needed ProjectsMilestoneRelationshipsDevelopmentIssue actions |
| You are visitor 01402503 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |