Improve issue management (closes #346). #347

McCodeman · 2020-01-29T18:54:34Z

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.

antrea-bot · 2020-01-29T18:54:50Z

Thanks for your PR.
Unit tests and code linters are run automatically every time the PR is updated.
E2e, conformance and network policy tests can only be triggered by a member of the vmware-tanzu organization. Regular contributors to the project should join the org.

The following commands are available:

/test-e2e: to trigger e2e tests.
/skip-e2e: to skip e2e tests.
/test-conformance: to trigger conformance tests.
/skip-conformance: to skip conformance tests.
/test-networkpolicy: to trigger networkpolicy tests.
/skip-networkpolicy: to skip networkpolicy tests.
/test-all: to trigger all tests.
/skip-all: to skip all tests.

These commands can only be run by members of the vmware-tanzu organization.

McCodeman · 2020-01-29T18:56:48Z

Some of the file changes in CONTRIBUTING.md due to reformatting markdown to 80 columns.

antoninbas

LGTM

Adding Abhishek who wrote most of the original contributing.md guide

I think you're the only one who will be able to edit the graffle file :)

This does not document our commands for running tests, (/test-all, etc.) but these are likely to change in the near future and postponing to a future PR is likely the right thing to do.

CONTRIBUTING.md

docs/labels.md

antoninbas

found 2 more typos as I was giving this a second read through

CONTRIBUTING.md

docs/github-labels.md

CONTRIBUTING.md

docs/github-labels.md

docs/issue-management.md

antrea-bot · 2020-02-12T19:57:18Z

Thanks for your PR.
Unit tests and code linters are run automatically every time the PR is updated.
E2e, conformance and network policy tests can only be triggered by a member of the vmware-tanzu organization. Regular contributors to the project should join the org.

The following commands are available:

/test-e2e: to trigger e2e tests.
/skip-e2e: to skip e2e tests.
/test-conformance: to trigger conformance tests.
/skip-conformance: to skip conformance tests.
/test-networkpolicy: to trigger networkpolicy tests.
/skip-networkpolicy: to skip networkpolicy tests.
/test-all: to trigger all tests.
/skip-all: to skip all tests.

These commands can only be run by members of the vmware-tanzu organization.

McCodeman · 2020-02-12T22:11:47Z

/skip-all

CONTRIBUTING.md

docs/issue-management.md

antrea-bot · 2020-02-13T21:19:44Z

Thanks for your PR.
Unit tests and code linters are run automatically every time the PR is updated.
E2e, conformance and network policy tests can only be triggered by a member of the vmware-tanzu organization. Regular contributors to the project should join the org.

The following commands are available:

/test-e2e: to trigger e2e tests.
/skip-e2e: to skip e2e tests.
/test-conformance: to trigger conformance tests.
/skip-conformance: to skip conformance tests.
/test-networkpolicy: to trigger networkpolicy tests.
/skip-networkpolicy: to skip networkpolicy tests.
/test-all: to trigger all tests.
/skip-all: to skip all tests.

These commands can only be run by members of the vmware-tanzu organization.

antrea-bot · 2020-02-13T21:21:18Z

Thanks for your PR.
Unit tests and code linters are run automatically every time the PR is updated.
E2e, conformance and network policy tests can only be triggered by a member of the vmware-tanzu organization. Regular contributors to the project should join the org.

The following commands are available:

/test-e2e: to trigger e2e tests.
/skip-e2e: to skip e2e tests.
/test-conformance: to trigger conformance tests.
/skip-conformance: to skip conformance tests.
/test-networkpolicy: to trigger networkpolicy tests.
/skip-networkpolicy: to skip networkpolicy tests.
/test-all: to trigger all tests.
/skip-all: to skip all tests.

These commands can only be run by members of the vmware-tanzu organization.

antrea-bot · 2020-02-13T21:33:00Z

Thanks for your PR.
Unit tests and code linters are run automatically every time the PR is updated.
E2e, conformance and network policy tests can only be triggered by a member of the vmware-tanzu organization. Regular contributors to the project should join the org.

The following commands are available:

/test-e2e: to trigger e2e tests.
/skip-e2e: to skip e2e tests.
/test-conformance: to trigger conformance tests.
/skip-conformance: to skip conformance tests.
/test-networkpolicy: to trigger networkpolicy tests.
/skip-networkpolicy: to skip networkpolicy tests.
/test-all: to trigger all tests.
/skip-all: to skip all tests.

These commands can only be run by members of the vmware-tanzu organization.

antoninbas

Did another thorough review of this. LGTM, apart from a few things I pointed out. This has been opened for a while, so hopefully we can merge it soon.

antoninbas · 2020-02-18T22:12:45Z

docs/github-labels.md

+| Label | Description | Added By |
+|-------|-------------|----------|
+| approved                           | Indicates a PR has been approved by OWNERS in accordance with [GOVERNANCE.md](GOVERNANCE.md) guidelines. | Maintainers |
+| vmware-cla: no                     | Indicates the PR's author has not signed the (VMware CLA)[https://cla.vmware.com/faq] | VMware CLA Bot |


The link does not render properly: there can be no whitespace between (VMware CLA) and [https://cla.vmware.com/faq]

still not fixed (when I look at the Github markdown rendering for the file), maybe they need to be on the same line...

antoninbas · 2020-02-18T22:12:52Z

docs/github-labels.md

+|-------|-------------|----------|
+| approved                           | Indicates a PR has been approved by OWNERS in accordance with [GOVERNANCE.md](GOVERNANCE.md) guidelines. | Maintainers |
+| vmware-cla: no                     | Indicates the PR's author has not signed the (VMware CLA)[https://cla.vmware.com/faq] | VMware CLA Bot |
+| vmware-cla: yes                    | Indicates the PR's author has signed the (VMware CLA)[https://cla.vmware.com/faq] | VMware CLA Bot |


same as above

docs/github-labels.md

docs/issue-management.md

CONTRIBUTING.md

docs/github-labels.md

antrea-bot · 2020-06-01T17:40:16Z

Thanks for your PR.
Unit tests and code linters are run automatically every time the PR is updated.
E2e, conformance and network policy tests can only be triggered by a member of the vmware-tanzu organization. Regular contributors to the project should join the org.

The following commands are available:

/test-e2e: to trigger e2e tests.
/skip-e2e: to skip e2e tests.
/test-conformance: to trigger conformance tests.
/skip-conformance: to skip conformance tests.
/test-networkpolicy: to trigger networkpolicy tests.
/skip-networkpolicy: to skip networkpolicy tests.
/test-windows-conformance: to trigger windows conformance tests.
/skip-windows-conformance: to skip windows conformance tests.
/test-all: to trigger all tests.
/skip-all: to skip all tests.

These commands can only be run by members of the vmware-tanzu organization.

McCodeman · 2020-06-01T22:33:03Z

/skip-all

McCodeman · 2020-06-01T22:33:57Z

The forced push was due to a rebase to ensure we are reviewing latest set of docs.

antoninbas

Another thorough review and found a few more typos

The CI spell checker also found a couple

antoninbas · 2020-06-02T00:54:45Z

CONTRIBUTING.md

+Once an issue has been submitted, the CI (GitHub actions) or a human will
+automatically review the submitted issue or PR to ensure that it has all relevant
+information. If information is lacking or there is another problem with the
+submitted issue, an appropriate [`triage/<?>`](#triage) label will be


not a valid link, there is no triage section in this doc

antoninbas · 2020-06-02T00:54:54Z

CONTRIBUTING.md

+applied.
+
+After an issue has been triaged, the maintainers can prioritize the issue with
+an appropriate [`priority/<?>`](#priority) label.


not a valid link, there is no priority section in this doc

antoninbas · 2020-06-02T00:56:28Z

CONTRIBUTING.md

+* [`kind/feature`](docs/issue-management.md#feature) -- for proposing a feature
+* [`kind/support`](docs/issue-management.md#support) -- to request support. You may also get support by
+  using our [Slack](https://kubernetes.slack.com/archives/CR2J23M0X) channel for
+  interactive help. If you have not setup the appropriate accounts, please


nit: s/setup/set up
setup is the noun, set up is the verb

antoninbas · 2020-06-02T01:01:30Z

docs/github-labels.md

+| Label | Description | Added By |
+|-------|-------------|----------|
+| approved                           | Indicates a PR has been approved by OWNERS in accordance with [GOVERNANCE.md](GOVERNANCE.md) guidelines. | Maintainers |
+| vmware-cla: no                     | Indicates the PR's author has not signed the (VMware CLA)[https://cla.vmware.com/faq] | VMware CLA Bot |


still not fixed (when I look at the Github markdown rendering for the file), maybe they need to be on the same line...

antoninbas · 2020-06-02T01:01:34Z

docs/github-labels.md

+|-------|-------------|----------|
+| approved                           | Indicates a PR has been approved by OWNERS in accordance with [GOVERNANCE.md](GOVERNANCE.md) guidelines. | Maintainers |
+| vmware-cla: no                     | Indicates the PR's author has not signed the (VMware CLA)[https://cla.vmware.com/faq] | VMware CLA Bot |
+| vmware-cla: yes                    | Indicates the PR's author has signed the (VMware CLA)[https://cla.vmware.com/faq] | VMware CLA Bot |


antoninbas · 2020-06-02T01:04:04Z

docs/issue-management.md

+  processes.
+* `help wanted` -- issues that represent clearly laid out tasks that are
+  generally tractable for new contributors. The solution has already been
+  designed and requires no further discussion from the community. This labels


s/This labels/This label

antoninbas · 2020-06-02T01:08:41Z

docs/issue-management.md

+3. Apply [`size/<size>`](#size) label to the submission. (TODO: we plan to
+   automate this with a GitHub action and apply size based on lines of code).
+4. Ensure that the PR references an existing issue (exceptions to this should be
+   rare). If the PR is missing this or needs any additional information, notate


I thought "notate" was used specifically for music. Maybe "note it in a comment"?

You are correct. Changed.

antoninbas · 2020-06-02T01:13:39Z

docs/issue-management.md

+
+### Size
+
+Size labels beting with `size/<size>` and estimate the relative complexity or work


s/beting/begin

Corrected. Not sure why spell check plugin not picking this up. Will investigate.

It's my understanding that the spell checker only catches the most common spelling mistakes and does not lookup each work in a dictionary, as I would image there would be too many false positives for technical documentation.

antoninbas · 2020-06-02T01:14:22Z

docs/issue-management.md

+
+### Triage
+
+As soon as new issue are submitted, they must be triaged until they are ready to


s/new issue are submitted, they/new issues are submitted, they

antoninbas · 2020-06-02T01:15:36Z

docs/issue-management.md

+TODO: Additional CI automation (GitHub actions) will be used to automatically
+apply and manage some of these lifecycle labels.
+
+Lifecycle labels are defined in [`docs/github-labels.md`](docs/github-labels.md).


link not working because of missing leading slash

Should have relative link so this work correctly in site docs. Have corrected.

McCodeman · 2020-06-02T03:17:21Z

/skip-all

antoninbas

LGTM

antoninbas · 2020-06-02T04:58:33Z

@McCodeman actually looks like you haven't fixed the errors reported by the spell checker yet?

* 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.

* 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 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`

* spelling, grammar, formatting, typo corrections

* corrected typos

* 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

antoninbas

LGTM

antoninbas · 2020-06-02T18:12:27Z

/skip-all

antoninbas · 2020-06-02T18:35:12Z

Ignoring failed Kind test because this is purely a documentation PR

* 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.

vmwclabot added the cla-not-required label Jan 29, 2020

McCodeman requested a review from antoninbas January 29, 2020 19:01

antoninbas reviewed Jan 29, 2020

View reviewed changes

antoninbas requested a review from abhiraut January 29, 2020 21:38

jianjuns reviewed Jan 29, 2020

View reviewed changes

docs/labels.md Outdated Show resolved Hide resolved

docs/labels.md Outdated Show resolved Hide resolved

docs/labels.md Outdated Show resolved Hide resolved

antoninbas reviewed Feb 6, 2020

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

abhiraut reviewed Feb 7, 2020

View reviewed changes

antoninbas reviewed Feb 11, 2020

View reviewed changes

abhiraut reviewed Feb 12, 2020

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

docs/issue-management.md Outdated Show resolved Hide resolved

docs/issue-management.md Outdated Show resolved Hide resolved

antoninbas reviewed Feb 18, 2020

View reviewed changes

abhiraut reviewed Feb 27, 2020

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

docs/github-labels.md Outdated Show resolved Hide resolved

McCodeman force-pushed the project-management branch from fae87c1 to a96c7fb Compare June 1, 2020 17:39

antoninbas reviewed Jun 2, 2020

View reviewed changes

antoninbas previously approved these changes Jun 2, 2020

View reviewed changes

antoninbas self-requested a review June 2, 2020 04:58

McCodeman added 3 commits June 2, 2020 12:56

Added newline to end of .gitignore

7d5b0ee

McCodeman added 13 commits June 2, 2020 12:56

Clarify good first issue and help wanted labels.

ce97c99

* spelling, grammar, formatting, typo corrections

Added area/component labels.

74581ac

Added github label area/interface

1b87020

Added label area/build-release

ec35414

Corrected developer workflow visualization URL

1f48775

* corrected typos

Removed spurious asterix in priority bullet list

7078bcc

Added `area/monitoring/health-performance

3043cd2

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

518a750

Spelling/typo corrections to issue-management.

a4de983

Documentation edits based on feedback

61a1a4d

* 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.

cac8f4b

Fixed spelling errors.

0e80588

McCodeman dismissed antoninbas’s stale review via 0e80588 June 2, 2020 17:57

McCodeman force-pushed the project-management branch from 127ce24 to 0e80588 Compare June 2, 2020 17:57

antoninbas approved these changes Jun 2, 2020

View reviewed changes

antoninbas merged commit 572524a into antrea-io:master Jun 2, 2020


		### Size

		Size labels beting with `size/<size>` and estimate the relative complexity or work


		### Triage

		As soon as new issue are submitted, they must be triaged until they are ready to

Improve issue management (closes #346). #347

Improve issue management (closes #346). #347

Conversation

McCodeman commented Jan 29, 2020

antrea-bot commented Jan 29, 2020

McCodeman commented Jan 29, 2020

antoninbas left a comment

Choose a reason for hiding this comment

antoninbas left a comment

Choose a reason for hiding this comment

antrea-bot commented Feb 12, 2020

McCodeman commented Feb 12, 2020

antrea-bot commented Feb 13, 2020

antrea-bot commented Feb 13, 2020

antrea-bot commented Feb 13, 2020

antoninbas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

antrea-bot commented Jun 1, 2020

McCodeman commented Jun 1, 2020

McCodeman commented Jun 1, 2020

antoninbas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

McCodeman commented Jun 2, 2020

antoninbas left a comment

Choose a reason for hiding this comment

antoninbas commented Jun 2, 2020

antoninbas left a comment

Choose a reason for hiding this comment

antoninbas commented Jun 2, 2020

antoninbas commented Jun 2, 2020