vote for pr issue association rule#606
Conversation
|
[REVIEW NOTIFICATION] This pull request has been approved by:
To complete the pull request process, please ask the reviewers in the list to review by filling The full list of commands accepted by this bot can be found here. DetailsReviewer can indicate their review by submitting an approval review. |
|
/hold |
|
also /cc @pingcap/tidb-committers @pingcap/tidb-reviewers since this affects everyone |
|
|
||
| Issue number in PR body will become a mandatory requirement. Currently, the PR template contains one line `Issue Number: close #xxx`, but this is not mandatory. Contributors are free to leave it empty or delete the whole content. | ||
|
|
||
| After this proposal, the bot will check whether there is relevant issue number(s) in the PR body, by `Issue Number: ref #{issue-number}` or `Issue Number: close[sd]?|resolve[sd]?|fix(e[sd])? #{issue-number}`. `ref` means associated with an issue but does not close it. There should be no other content in the same line and the check is case-insensitive. Multiple issues should be separated by a comma, like `Issue Number: close #12341, close #12342`. For PRs trying to close issues in a different repository, contributors need to first create an issue in the same repository and use this issue to track. |
There was a problem hiding this comment.
can we tolerate “close https://github.com/pingcap/repo/issue/1234”? sometimes i like copy and paste urls and this also enables cross repo reference
There was a problem hiding this comment.
I think this suppose to work as long as it points to a valid issue link.
There was a problem hiding this comment.
Actually we follow Github's rule https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword with some tweaks. First add ref and then disallow cross repo reference. ref adds one semantic. And forcing the issue and PR in one repo helps other members like QA and release managers' work(they may need to apply labels to the issues). We recommend create a new issue in the repo and use the issue to track.
There was a problem hiding this comment.
it helps other members like QA and release managers' work(they may need to apply labels to the issues)
if they need add labels, less issue means less manual work. if one problem is related to many repo (like need to update dependency) more redundant issues will be spawned.
There was a problem hiding this comment.
It makes some sense. But this means you have to take all related repos into considerations as a whole and switching back and forth to track the issue. If the repos don't share the same version strategy it also makes life harder. Updating dependencies sometimes means a bugfix so may affects multiple version so a dedicated issue could help. Such scenarios won't occur frequently.
There was a problem hiding this comment.
Talking about repos, we are consolidating repos. It's going to help reducing redundant issues.
|
ping @pingcap/tidb-maintainers @pingcap/migration-maintainers |
|
/unhold |
|
/merge |
|
This pull request has been accepted and is ready to merge. DetailsCommit hash: ce8516c |
ref #604
Co-authored-by: @tisonkun
Co-authored-by: @Mini256