Doc: create issue and PR management guidelines #10668
Conversation
|
@philips @xiang90 @hexfusion @gyuho @jpbetz as I mentioned in the PR description, I have created this PR with two docs to start the discussion. I am hopping that these guidelines will evolve and should be helpful to contributors to understand the triage process, and mainly help us to close inactive issues and PRs in a timely manner to keep their number in check. I am open for suggestions and feedback. Thanks! |
Codecov Report
@@ Coverage Diff @@
## master #10668 +/- ##
==========================================
+ Coverage 71.37% 71.61% +0.24%
==========================================
Files 393 393
Lines 36629 36629
==========================================
+ Hits 26145 26233 +88
+ Misses 8633 8549 -84
+ Partials 1851 1847 -4
Continue to review full report at Codecov.
|
Absolutely! Thanks @hexfusion You read my mind :-) Just added it in the meeting agenda! |
Documentation/triage/PRs.md
Outdated
|
|
||
| ## Verify important labels are in place | ||
|
|
||
| Make sure that appropriate reviewers are added to the PR. Also make sure that milestone is identified. If any of these or other important labels are missing, add them. If correct label can not be decided, leave a comment for the maintainers of the SIG to do so if needed. |
There was a problem hiding this comment.
remove the mentioning of SIG. no sig in etcd :P
There was a problem hiding this comment.
ah..yeah..LOL. Thanks @xiang90 I will remove it!
|
looks pretty good. we probably need to have bot to close PR/issue, ping assigned owner automatically. |
Documentation/triage/issues.md
Outdated
|
|
||
| ## Validate if an issue is a bug | ||
|
|
||
| Validate if the issue is indeed a bug. If not, add a comment with findings and close trivial issue. For non-trivial issue, wait to hear back from issue reporter and see if there is any objection. If issue reporter does not reply in 30 days, close the issue. |
There was a problem hiding this comment.
Some issues are reported with only error messages but with no reproduce steps, which makes it difficult to validate if it is indeed a bug. Maybe add something like "if more information is needed from issue reporter, ..."?
There was a problem hiding this comment.
@jingyih sure, that's a good idea, will do!
@xiang90 thanks so much for the quick review and yes having bot for tasks you mentioned would be great. Also probably some labels down the road - for things like what @jingyih mentioned when more information is needed from issue reporter to reproduce or understand the issue better (e.g. labeling the issue with |
I would like to propose a formal guide for issue triage and PR management. This should help us keep open issues and PRs under a desirable numbers. For example, keep issues under 100. These guidelines should specially help manage and close issues and PRs that are inactive in a timely manner.
|
@xiang90 @hexfusion @jingyih should we merge this if there are no more review comments, so that we have guidelines in place? Thanks! |
|
Sure. Let us merge this in first. We need to link two these two docs from main doc page or readme though. |
@xiang90 thank you so much and yes, that's definitely a good idea!! I will work on it, let me try to find out where it fits and will send it for review. Thanks! |
|
It would be great if someone could investigate using some of the Kubernetes Prow infrastructure to automate some of these things. |
related: etcd-io#10668 Provide a ref to the issue and PR management doc from the README, similar to other references we have provided in the README.
I would like to propose a formal guide for issue triage and PR management. This should help us keep open issues and PRs under a desirable number. For example, keep issues under 100. These guidelines should specially help manage and close issues and PRs that are inactive in a timely manner.
Sometimes back I had proposed triage guidelines to the Kubernetes community and created one working with the community. Here is a link for reference http://bit.ly/2W0PM4j In the community smaller projects and SIGs are also encouraged to create formal triage doc to keep issues and PRs numbers in check.