From 6527e066fcbe64d5878aa6e0d9a8d31e44571b76 Mon Sep 17 00:00:00 2001 From: thomashchan1 <40474519+thomashchan1@users.noreply.github.com> Date: Tue, 25 Jun 2019 21:35:51 -0700 Subject: [PATCH 01/14] Update CONTRIBUTING.md --- CONTRIBUTING.md | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f958c201167..fa37e18b425 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,4 +18,41 @@ OK on GitHub. We highly encourage to use line breaks in markdown files at `80` characters wide. There are tools that can do it for you effectively. Please submit proposal to include your editor settings required to enable this behavior so the out of -the box settings for this repository will be consistent. \ No newline at end of file +the box settings for this repository will be consistent. + +## SLA + +For Issues + +-For original poster (OP), after opening an urgent issue, please allow at least +(proposed) 1 business day before following up with the triager or assignee to +give time to work the issue and respond. Feel free to provide additional info/data +or ask further questions at anytime. Use URGENT label to distinguish from other +issues and provide reason behind the urgency. + +-For OP, after opening a non-urgent issue, please allow at least (proposed) 3 +business days before follow up with the triager or assignee to give time to work +the issue and respond. Feel free to provide additional info/data or ask further +questions at anytime. + +-For assignee, if the associated PR is merged, please proceed to close the issue, +if not done already. For issues without PR and after providing +answers/resolution/workarounds, please allow at least (proposed) 2 business days +for OP to respond/acknowledge before closing an issue. + +For PRs + +-Please allow a minimum of (proposed) 3 business days review period for PRs before +they could be merged. + +-Maximum response time from reviewers/contributors: proposing 3 business days. + +-If there is an exception to the general SLA, please highlight reasons in comments. +Valid exceptions are urgent fixes, typo, bug fixes, doc improvements, backfilling tests, +adding CI PRs or implementing what have already been discussed/agreed, etc.. + +-If SLA is violated and with no reason/justification comments, please be prepared to +accept another PR which could modify or rollback prior changes. + +-Proposing to have 2 approvals from different companies for interface/design impacting changes. + From f38731a3650bb885ab3a36cfa76583afd97cbd5f Mon Sep 17 00:00:00 2001 From: thomashchan1 <40474519+thomashchan1@users.noreply.github.com> Date: Tue, 25 Jun 2019 21:38:31 -0700 Subject: [PATCH 02/14] Update CONTRIBUTING.md --- CONTRIBUTING.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa37e18b425..d77cd50f8c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,35 +24,35 @@ the box settings for this repository will be consistent. For Issues --For original poster (OP), after opening an urgent issue, please allow at least +* For original poster (OP), after opening an urgent issue, please allow at least (proposed) 1 business day before following up with the triager or assignee to give time to work the issue and respond. Feel free to provide additional info/data or ask further questions at anytime. Use URGENT label to distinguish from other issues and provide reason behind the urgency. --For OP, after opening a non-urgent issue, please allow at least (proposed) 3 +* For OP, after opening a non-urgent issue, please allow at least (proposed) 3 business days before follow up with the triager or assignee to give time to work the issue and respond. Feel free to provide additional info/data or ask further questions at anytime. --For assignee, if the associated PR is merged, please proceed to close the issue, +* For assignee, if the associated PR is merged, please proceed to close the issue, if not done already. For issues without PR and after providing answers/resolution/workarounds, please allow at least (proposed) 2 business days for OP to respond/acknowledge before closing an issue. For PRs --Please allow a minimum of (proposed) 3 business days review period for PRs before +* Please allow a minimum of (proposed) 3 business days review period for PRs before they could be merged. --Maximum response time from reviewers/contributors: proposing 3 business days. +* Maximum response time from reviewers/contributors: proposing 3 business days. --If there is an exception to the general SLA, please highlight reasons in comments. +* If there is an exception to the general SLA, please highlight reasons in comments. Valid exceptions are urgent fixes, typo, bug fixes, doc improvements, backfilling tests, adding CI PRs or implementing what have already been discussed/agreed, etc.. --If SLA is violated and with no reason/justification comments, please be prepared to +* If SLA is violated and with no reason/justification comments, please be prepared to accept another PR which could modify or rollback prior changes. --Proposing to have 2 approvals from different companies for interface/design impacting changes. +* Proposing to have 2 approvals from different companies for interface/design impacting changes. From d8f5852f51dfd0f5a573f7122634e3b032fe46ce Mon Sep 17 00:00:00 2001 From: thomashchan1 <40474519+thomashchan1@users.noreply.github.com> Date: Mon, 22 Jul 2019 15:50:44 -0700 Subject: [PATCH 03/14] Update CONTRIBUTING.md --- CONTRIBUTING.md | 37 ------------------------------------- 1 file changed, 37 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d77cd50f8c9..4b48c2b98e8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,40 +19,3 @@ We highly encourage to use line breaks in markdown files at `80` characters wide. There are tools that can do it for you effectively. Please submit proposal to include your editor settings required to enable this behavior so the out of the box settings for this repository will be consistent. - -## SLA - -For Issues - -* For original poster (OP), after opening an urgent issue, please allow at least -(proposed) 1 business day before following up with the triager or assignee to -give time to work the issue and respond. Feel free to provide additional info/data -or ask further questions at anytime. Use URGENT label to distinguish from other -issues and provide reason behind the urgency. - -* For OP, after opening a non-urgent issue, please allow at least (proposed) 3 -business days before follow up with the triager or assignee to give time to work -the issue and respond. Feel free to provide additional info/data or ask further -questions at anytime. - -* For assignee, if the associated PR is merged, please proceed to close the issue, -if not done already. For issues without PR and after providing -answers/resolution/workarounds, please allow at least (proposed) 2 business days -for OP to respond/acknowledge before closing an issue. - -For PRs - -* Please allow a minimum of (proposed) 3 business days review period for PRs before -they could be merged. - -* Maximum response time from reviewers/contributors: proposing 3 business days. - -* If there is an exception to the general SLA, please highlight reasons in comments. -Valid exceptions are urgent fixes, typo, bug fixes, doc improvements, backfilling tests, -adding CI PRs or implementing what have already been discussed/agreed, etc.. - -* If SLA is violated and with no reason/justification comments, please be prepared to -accept another PR which could modify or rollback prior changes. - -* Proposing to have 2 approvals from different companies for interface/design impacting changes. - From a345fa449817fed6fa55575c57b409d5188fefd4 Mon Sep 17 00:00:00 2001 From: thomashchan1 <40474519+thomashchan1@users.noreply.github.com> Date: Mon, 22 Jul 2019 16:09:20 -0700 Subject: [PATCH 04/14] Create issue-management --- issue-management | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 issue-management diff --git a/issue-management b/issue-management new file mode 100644 index 00000000000..b2615f77eaa --- /dev/null +++ b/issue-management @@ -0,0 +1,39 @@ +# Issue Management for OpenTelemetry + +It's an important community goal for OpenTelemetry that our members find the backlogs +to be responsive, and easy to take part in. Shared practices will simplify collaboration +and engagement as well as help standardize on automation and overall project management. + +SIGs are encouraged to experiment with labels and backlog management procedures, +including project board. This document only covers the bare bones of issue management +which should work the same across all SIGs, to help maintain a responsive backlog and +allow us to track work across all projects in a similar manner. + + +## Roles + +- OP: + - Original Poster. This is the person who has opened or posted the issue. +- Maintainer (aka Triager, or anyone performing that role): + - Person who is triaging the issue by determining its workability. This person is + responsible for getting the tickets to one of two stages - 1) help-wanted + 2) will-not-fix. They are responsible for triaging by working with the OP to get + additional information as needed and analyzing the issue and adding relevant + details/information/guidance that would be helpful to the resolution of the issue. +- Collaborator: + - Person(s) that are actually doing the work related to the ticket. Once work is done, + they work with the Reviewer to get feedback implemented and complete the work. They + are responsible for making sure issue status labels are up to date. +- Reviewer: + - Person whose Approval is needed to merge the PR. + + +## Writing specs + +Specification is written in markdown format. Please make sure files are rendered +OK on GitHub. + +We highly encourage to use line breaks in markdown files at `80` characters +wide. There are tools that can do it for you effectively. Please submit proposal +to include your editor settings required to enable this behavior so the out of +the box settings for this repository will be consistent. From 1a1681607de38317558968cc6229cee6f215dfb3 Mon Sep 17 00:00:00 2001 From: thomashchan1 <40474519+thomashchan1@users.noreply.github.com> Date: Mon, 22 Jul 2019 16:09:44 -0700 Subject: [PATCH 05/14] Rename issue-management to issue-management.md --- issue-management => issue-management.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename issue-management => issue-management.md (100%) diff --git a/issue-management b/issue-management.md similarity index 100% rename from issue-management rename to issue-management.md From 876e4309d7cee8f6391b2d96cd59945b0bd5c2bb Mon Sep 17 00:00:00 2001 From: thomashchan1 <40474519+thomashchan1@users.noreply.github.com> Date: Mon, 22 Jul 2019 20:21:06 -0700 Subject: [PATCH 06/14] Update issue-management.md --- issue-management.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/issue-management.md b/issue-management.md index b2615f77eaa..f916ee9296f 100644 --- a/issue-management.md +++ b/issue-management.md @@ -16,8 +16,8 @@ allow us to track work across all projects in a similar manner. - Original Poster. This is the person who has opened or posted the issue. - Maintainer (aka Triager, or anyone performing that role): - Person who is triaging the issue by determining its workability. This person is - responsible for getting the tickets to one of two stages - 1) help-wanted - 2) will-not-fix. They are responsible for triaging by working with the OP to get + responsible for getting the tickets to one of two stages - 1) `help-wanted` + 2) `will-not-fix`. They are responsible for triaging by working with the OP to get additional information as needed and analyzing the issue and adding relevant details/information/guidance that would be helpful to the resolution of the issue. - Collaborator: From 4b24e6b081eb1820e005943c14bdf9ff5475cf50 Mon Sep 17 00:00:00 2001 From: thomashchan1 <40474519+thomashchan1@users.noreply.github.com> Date: Mon, 22 Jul 2019 20:45:16 -0700 Subject: [PATCH 07/14] Update issue-management.md --- issue-management.md | 65 ++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 62 insertions(+), 3 deletions(-) diff --git a/issue-management.md b/issue-management.md index f916ee9296f..153820f6020 100644 --- a/issue-management.md +++ b/issue-management.md @@ -28,10 +28,69 @@ allow us to track work across all projects in a similar manner. - Person whose Approval is needed to merge the PR. -## Writing specs +## Opening an Issue -Specification is written in markdown format. Please make sure files are rendered -OK on GitHub. +- An issue is filed by OP. +- A Maintainer responds and asks clarifying questions within 1-2 business days. +- The Maintainer processes the issue and lables it as: + - `bug` + - `enhancement` + - `need-discussion` + - `documentation` or + - `will-not-fix` (thereby closing the issue with explicit reasons) +- The Maintainer can also label the issue as + - `URGENT` (for critical issues) + - `help-wanted` for issues which require work and have no one assigned +- Once a Collaborator is assigned, please remove `help-wanted` and add `wip` to + the issue. + + +## Closing an Issue + +- Review criteria: + - For interface and design changes: 2 approvals - which must be from reviewers + who work at different companies than the Collaborator. + - For smaller or internal changes: 1 approval from a different company. +- For `URGENT` issues: + - Collaborator: please provide initial assessment of the issues to OP ASAP or + within 1 business day, whichever is earlier. + - Reviewer: please review and provide feedback ASAP or within 1 business day, + whichever is earlier. + - Collaborator: please provide update and/or responses to review comments ASAP + or within 1 business day, whichever is sooner. Merge should happen as soon as + review criteria are met. +- For non-`URGENT` issues + - Collaborator: please provide initial response or assessment of the issue to + OP within 3 business days. + - Reviewer: please review and provide feedback within 3 business days. + - Collaborator: please provide update and/or responses to review comments + within 3 business days. Once all review comments are resolved, please allow + 1-2 business days for others to raise additional comments/questions, unless + the changes are fixing typos, bugs, documentation, test enhancements, or + implementing already discussed design. + +When closing an issue that we `will-not-fix` or we believe need no further +action, please provide the rationale for closing, and indicate that OP can +re-open for discussion if there are additional info, justification and +questions. + + +## When Issues Get Stuck + +Some issues are not directly related to a particular code change. If an +issue is worth considering in the issue backlog, but not scoped clearly +enough for work to begin, then please label it `needs-discussion`. + +- When possible, move the disucssion forward by using tests and code examples. +- If discussion happens elsewhere, record relevant meeting notes into the + issue. +- When an agreement is made, clearly summarize the decision, and list any + resulting action items which need to be addressed. + +If an issue is stuck because someone is not responding, please add the `stale` +label. It is possible to automate this. E.g. https://github.com/apps/stale +The minimum time elapsed before the `stale` label is applied is proposed to be +one week. We highly encourage to use line breaks in markdown files at `80` characters wide. There are tools that can do it for you effectively. Please submit proposal From 2f9e0faa21fa6a53545c97adeffb65f34e7f14f2 Mon Sep 17 00:00:00 2001 From: thomashchan1 <40474519+thomashchan1@users.noreply.github.com> Date: Mon, 22 Jul 2019 20:47:03 -0700 Subject: [PATCH 08/14] Update issue-management.md --- issue-management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/issue-management.md b/issue-management.md index 153820f6020..e0231048046 100644 --- a/issue-management.md +++ b/issue-management.md @@ -79,7 +79,7 @@ questions. Some issues are not directly related to a particular code change. If an issue is worth considering in the issue backlog, but not scoped clearly -enough for work to begin, then please label it `needs-discussion`. +enough for work to begin, then please label it `need-discussion`. - When possible, move the disucssion forward by using tests and code examples. - If discussion happens elsewhere, record relevant meeting notes into the From 70478e0bf70fd616d78ec7561845912b57a26cb2 Mon Sep 17 00:00:00 2001 From: thomashchan1 <40474519+thomashchan1@users.noreply.github.com> Date: Tue, 23 Jul 2019 12:45:10 -0700 Subject: [PATCH 09/14] Update issue-management.md --- issue-management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/issue-management.md b/issue-management.md index e0231048046..a42c7d7578b 100644 --- a/issue-management.md +++ b/issue-management.md @@ -32,7 +32,7 @@ allow us to track work across all projects in a similar manner. - An issue is filed by OP. - A Maintainer responds and asks clarifying questions within 1-2 business days. -- The Maintainer processes the issue and lables it as: +- The Maintainer processes the issue and labels it as: - `bug` - `enhancement` - `need-discussion` From 65a808a9d14a87abc6a2534a39221994cf22349b Mon Sep 17 00:00:00 2001 From: thomashchan1 <40474519+thomashchan1@users.noreply.github.com> Date: Tue, 23 Jul 2019 12:52:11 -0700 Subject: [PATCH 10/14] Update issue-management.md --- issue-management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/issue-management.md b/issue-management.md index a42c7d7578b..c5b4badcf30 100644 --- a/issue-management.md +++ b/issue-management.md @@ -81,7 +81,7 @@ Some issues are not directly related to a particular code change. If an issue is worth considering in the issue backlog, but not scoped clearly enough for work to begin, then please label it `need-discussion`. -- When possible, move the disucssion forward by using tests and code examples. +- When possible, move the discussion forward by using tests and code examples. - If discussion happens elsewhere, record relevant meeting notes into the issue. - When an agreement is made, clearly summarize the decision, and list any From 582cccdb2e46e0a11b8f0ae2e865857c90775c54 Mon Sep 17 00:00:00 2001 From: thomashchan1 <40474519+thomashchan1@users.noreply.github.com> Date: Tue, 23 Jul 2019 12:54:47 -0700 Subject: [PATCH 11/14] Update issue-management.md --- issue-management.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/issue-management.md b/issue-management.md index c5b4badcf30..e22b5901625 100644 --- a/issue-management.md +++ b/issue-management.md @@ -91,8 +91,3 @@ If an issue is stuck because someone is not responding, please add the `stale` label. It is possible to automate this. E.g. https://github.com/apps/stale The minimum time elapsed before the `stale` label is applied is proposed to be one week. - -We highly encourage to use line breaks in markdown files at `80` characters -wide. There are tools that can do it for you effectively. Please submit proposal -to include your editor settings required to enable this behavior so the out of -the box settings for this repository will be consistent. From 5998fdb8972f51ec3a5a8e3ac0d85441b6593456 Mon Sep 17 00:00:00 2001 From: thomashchan1 <40474519+thomashchan1@users.noreply.github.com> Date: Wed, 24 Jul 2019 16:10:24 -0700 Subject: [PATCH 12/14] Update issue-management.md --- issue-management.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/issue-management.md b/issue-management.md index e22b5901625..3ed45871034 100644 --- a/issue-management.md +++ b/issue-management.md @@ -35,7 +35,7 @@ allow us to track work across all projects in a similar manner. - The Maintainer processes the issue and labels it as: - `bug` - `enhancement` - - `need-discussion` + - `needs-discussion` - `documentation` or - `will-not-fix` (thereby closing the issue with explicit reasons) - The Maintainer can also label the issue as @@ -79,7 +79,7 @@ questions. Some issues are not directly related to a particular code change. If an issue is worth considering in the issue backlog, but not scoped clearly -enough for work to begin, then please label it `need-discussion`. +enough for work to begin, then please label it `needs-discussion`. - When possible, move the discussion forward by using tests and code examples. - If discussion happens elsewhere, record relevant meeting notes into the From 2af5ac6fc8fddb9e13f2748826d5ee7133729f5e Mon Sep 17 00:00:00 2001 From: thomashchan1 <40474519+thomashchan1@users.noreply.github.com> Date: Wed, 24 Jul 2019 16:13:35 -0700 Subject: [PATCH 13/14] Update issue-management.md Co-Authored-By: Chris Kleinknecht --- issue-management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/issue-management.md b/issue-management.md index 3ed45871034..767a08cb528 100644 --- a/issue-management.md +++ b/issue-management.md @@ -56,7 +56,7 @@ allow us to track work across all projects in a similar manner. within 1 business day, whichever is earlier. - Reviewer: please review and provide feedback ASAP or within 1 business day, whichever is earlier. - - Collaborator: please provide update and/or responses to review comments ASAP + - Collaborator: please provide an update and/or responses to review comments ASAP or within 1 business day, whichever is sooner. Merge should happen as soon as review criteria are met. - For non-`URGENT` issues From c972439a94c14e0c3318131252995f749ae378cc Mon Sep 17 00:00:00 2001 From: thomashchan1 <40474519+thomashchan1@users.noreply.github.com> Date: Wed, 24 Jul 2019 16:17:15 -0700 Subject: [PATCH 14/14] Update issue-management.md --- issue-management.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/issue-management.md b/issue-management.md index 767a08cb528..1f1422e0274 100644 --- a/issue-management.md +++ b/issue-management.md @@ -52,18 +52,18 @@ allow us to track work across all projects in a similar manner. who work at different companies than the Collaborator. - For smaller or internal changes: 1 approval from a different company. - For `URGENT` issues: - - Collaborator: please provide initial assessment of the issues to OP ASAP or + - Collaborator: please provide an initial assessment of the issues to OP ASAP or within 1 business day, whichever is earlier. - Reviewer: please review and provide feedback ASAP or within 1 business day, whichever is earlier. - - Collaborator: please provide an update and/or responses to review comments ASAP + - Collaborator: please provide an update and/or response to each review comment ASAP or within 1 business day, whichever is sooner. Merge should happen as soon as review criteria are met. - For non-`URGENT` issues - - Collaborator: please provide initial response or assessment of the issue to + - Collaborator: please provide an initial response or assessment of the issue to OP within 3 business days. - Reviewer: please review and provide feedback within 3 business days. - - Collaborator: please provide update and/or responses to review comments + - Collaborator: please provide an update and/or response to each review comment within 3 business days. Once all review comments are resolved, please allow 1-2 business days for others to raise additional comments/questions, unless the changes are fixing typos, bugs, documentation, test enhancements, or