Current state: Under Discussion
Discussion thread: N/A
JIRA: N/A
Released: N/A
Community have voted and decided to start using Github issues/pull requests for issue tracking for 3 months.
however, It needs some Github permissions and some simple/basic rules to follow.
Github Issue and Pull Requests
We can use Issue/Pull Request templates (https://github.com/blog/2111-issue-and-pull-request-template )to give user instructions on what should be described in issues and pull requests. Here are two attached templates.
If a change is trivial, or you have the code ready, you can open a PR directly; otherwise create an issue for discussion before starting writing code.
Issue Labeling
Release - We can use “milestone” for managing releases.
We can start with minimal labels, iterate and add more if the labels are really needed.
Type/Kind: {bug, feature, task}
Component/Area: {protocol, client, bookie, tests, documentation}
Priority: {blocker}. If it is a blocker, mark it a blocker. Otherwise leaves it unmarked.
Closing the PR
Ask INFRA if we have the permission to merge directly in Github.
If we have, enable “allow squash merging”, disable “allow merge commits” and “allow rebase merging” to make a clean commit history.
If we don’t have the permission, improving the merge-script to close both issue and PR
Currently the script closes the PR using commit messages (https://help.github.com/articles/closing-issues-via-commit-messages/), we need to improve the script to be able to find its corresponding issue, if there is one.
Requests corresponding permissions from INFRA
Permissions for committers to create labels and milestones
Permission for merge and close issues/pull requests
Add Issue and RP template under .github
Change to merge script to close PR and Issue
Update the pull request instruction at both website and wiki page