Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve issue management #346

Closed
McCodeman opened this issue Jan 29, 2020 · 0 comments
Closed

Improve issue management #346

McCodeman opened this issue Jan 29, 2020 · 0 comments
Assignees
@McCodeman
Labels
kind/design Categorizes issue or PR as related to design. lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. proposal A concrete proposal for adding a feature

Comments

@McCodeman
Copy link
Contributor

Describe what you are trying to solve
Improve issue management including triage, prioritization, and tracking using a comprehensive set of labels to describe issue kinds, areas, prioritization, triage status, etc. The use of these labels will enable the use of new project boards to better visualize current release burndown, backlog, and roadmap. Additionally, using GitHub actions, we can automate some triage tasks to ensure new issue submissions have sufficient information and ensure that stale issues are marked and closed appropriately.

Describe the solution you have in mind
To enable this process, the following contributions will be submitted:

  • a labels.md document will be added to ./docs that will describe in detail all the new labels being introduced.
  • changes to CONTRIBUTING.md will explain the process and how to use the labels.
  • labels will be added to the repository
  • the following project boards will be created:
    • for each release, a Release <version>, for example, Release v0.4.0 will be created to track the issues assigned to the release milestone
    • a Roadmap board will prioritize issues in the backlog
    • other boards as necessary for drilling down into specific project areas, stale and aged out issues, support issues, etc.

Describe how your solution impacts user flows
Does your solution impact how users interact with Antrea? If your proposal introduces a new user-facing feature, describe how it can be consumed.

This proposal does not directly impact users of Antrea but will require that either contributors apply some additional labels upon submission or other apply labels during triage.

Describe the main design/architecture of your solution
A clear and concise description of what does your solution look like. Rich text and diagrams are preferred.

Solution will be described in detail in CONTRIBUTING.md pull request.

Alternative solutions that you considered
A list of the alternative solutions that you considered, and why they fell short. You can list the pros and cons of each solution.

None, we will use GitHub issue management and automation features to keep tool sprawl to a minimum.

Test plan
Not applicable. New GitHub Actions will be tracked with their own new issues.

Additional context
Any other relevant information.
None.
@McCodeman McCodeman added the proposal A concrete proposal for adding a feature label Jan 29, 2020
@McCodeman McCodeman self-assigned this Jan 29, 2020
McCodeman added a commit to McCodeman/antrea that referenced this issue Jan 29, 2020
@McCodeman
Improve issue management (closes antrea-io#346).
6189391 
* Added a new `docs/labels.md` to reference all labels used in
GitHub issues and pull requests.
* Added a visual developer workflow diagram at
  `docs/assets/developer-workflow-opaque-bg.png` (original src
  graffle added as well).
* Updated `CONTRIBUTING.md` to reflect the improved issue
  management process.
@McCodeman McCodeman added kind/documentation Categorizes issue or PR as related to a documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. kind/design Categorizes issue or PR as related to design. lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. and removed kind/documentation Categorizes issue or PR as related to a documentation. labels Feb 12, 2020
McCodeman added a commit to McCodeman/antrea that referenced this issue Jun 1, 2020
@McCodeman
Improve issue management (closes antrea-io#346).
7781d19 
* Added a new `docs/labels.md` to reference all labels used in
GitHub issues and pull requests.
* Added a visual developer workflow diagram at
  `docs/assets/developer-workflow-opaque-bg.png` (original src
  graffle added as well).
* Updated `CONTRIBUTING.md` to reflect the improved issue
  management process.
McCodeman added a commit to McCodeman/antrea that referenced this issue Jun 2, 2020
@McCodeman
Improve issue management (closes antrea-io#346).
9f8f9f1 
* Added a new `docs/labels.md` to reference all labels used in
GitHub issues and pull requests.
* Added a visual developer workflow diagram at
  `docs/assets/developer-workflow-opaque-bg.png` (original src
  graffle added as well).
* Updated `CONTRIBUTING.md` to reflect the improved issue
  management process.
GraysonWu pushed a commit to GraysonWu/antrea that referenced this issue Sep 22, 2020
@McCodeman @GraysonWu
Improve issue management (closes antrea-io#346). (antrea-io#347)
9100da8 
* Improve issue management (closes antrea-io#346).

* Added a new `docs/labels.md` to reference all labels used in
GitHub issues and pull requests.
* Added a visual developer workflow diagram at
  `docs/assets/developer-workflow-opaque-bg.png` (original src
  graffle added as well).
* Updated `CONTRIBUTING.md` to reflect the improved issue
  management process.

* Added newline to end of .gitignore

* Typo fixes and suggestions for CONTRIBUTING.md and github-labels.md

* whitespace, punctuation, and spelling corrections
* wording on purpose of size labels
* removed /approve-api-change until action ready
* added and changed area github labels for OVS and testing
* instructions apply to both issues and PRs
* changed name of labels.md to github-labels.md

* Moved issue management detail topics to `docs/issue-management.md`

* moved issue-management detail topics in `CONTRIBUTING.md` to
  `docs/issue-management.md`
* grammar, spelling, formatting corrections
* requested  information for upgrades on `kind/api-change`
* updated links to `github-labels.md`

* Clarify good first issue and help wanted labels.

* spelling, grammar, formatting, typo corrections

* Added `area/component` labels.

* Added github label `area/interface`

* Added label `area/build-release`

* Corrected developer workflow visualization URL

* corrected typos

* Removed spurious asterix in priority bullet list

* Added `area/monitoring/health-performance

* Added link for how to use good first issue and help wanted.

* Spelling/typo corrections to issue-management.

* Documentation edits based on feedback

* simplified the section on filing-an-issue by merging with a
previous section on new issues
* consistent reference to "maintainers" and "owners"
* fixed broken links

* Fixed additional spelling, grammar, links.

* Fixed spelling errors.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@McCodeman McCodeman

Labels
kind/design Categorizes issue or PR as related to design. lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. proposal A concrete proposal for adding a feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@McCodeman