From 5848153c524805d7dd9182d555dc1157f5a5a340 Mon Sep 17 00:00:00 2001 From: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com> Date: Mon, 16 Aug 2021 09:29:25 -0400 Subject: [PATCH] Updated issue templates (#349) - Changed 'Issue' type to 'Backlog Item' - Consolidated 'Feature request' and 'Enhancement' into 'Enhancement' --- .../{issue.md => backlog_item.md} | 6 +++--- .github/ISSUE_TEMPLATE/enhancement.md | 20 ------------------- CONTRIBUTING.md | 18 ++++++++--------- 3 files changed, 12 insertions(+), 32 deletions(-) rename .github/ISSUE_TEMPLATE/{issue.md => backlog_item.md} (83%) delete mode 100644 .github/ISSUE_TEMPLATE/enhancement.md diff --git a/.github/ISSUE_TEMPLATE/issue.md b/.github/ISSUE_TEMPLATE/backlog_item.md similarity index 83% rename from .github/ISSUE_TEMPLATE/issue.md rename to .github/ISSUE_TEMPLATE/backlog_item.md index 5d9cad24b..5dcaae855 100644 --- a/.github/ISSUE_TEMPLATE/issue.md +++ b/.github/ISSUE_TEMPLATE/backlog_item.md @@ -1,6 +1,6 @@ --- -name: Issue -about: Use issues for planned work +name: Backlog item +about: Use backlog items for planned work title: '' labels: '' assignees: '' @@ -15,4 +15,4 @@ assignees: '' **Acceptance Criteria** - -- +- diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md deleted file mode 100644 index ff9288fba..000000000 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Enhancement -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f631d9fbc..da17c1df4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,8 +51,8 @@ These roles demonstrate how we think about doing the work. A single person can o ### Artifacts -- Product backlog: The product backlog is defined using GitHub issues. Issue templates are in the repo for Issues (new development) and bugs. Backlog items (issues and bugs) are grouped into releases and prioritized within each release. See the [product owner process](#product-owner-process) for more details. -- Monthly releases: Each release is defined using a GitHub project. One release is finished each month. We plan major themes for each release, but the actual content of a finished release depends on what is accomplished using our Kanban process. +- Product backlog: The product backlog is defined using GitHub issues. [Issue templates](.github/ISSUE_TEMPLATE) are in the repo for [backlog items (new development) and bugs](https://github.com/Azure/missionlz/issues/new/choose). Issues are grouped into releases and prioritized within each release. See the [product owner process](#product-owner-process) for more details. +- Monthly releases: Each release is defined using a GitHub project. GitHub projects are visible on the [Projects](https://github.com/Azure/missionlz/projects) tab of the GitHub site. One release is finished each month. We plan major themes for each release, but the actual content of a finished release depends on what is accomplished using our Kanban process. - Software increment: Each change to the software is implemented as a git commit to the main branch. GitHub pull requests are used to define and review each commit to main as a squashed merge (all changes combined into a single commit.) See the [development process](#development-process) for more details. ### Events @@ -88,7 +88,7 @@ A draft PR can be used to request feedback from the team. #### Review Other PRs -When PRs are requested, review each change and run full test deployment, specifically focused on the areas that have changed. Provide comments and feedback directly related to the PR. +When PRs are requested, review each change and run a full test deployment, specifically focused on the areas that have changed. Provide comments and feedback directly related to the PR. #### Ensure Quality @@ -98,20 +98,20 @@ The main branch is always production quality. The PR reviewer is responsible for #### Product Backlog -The backlog is defined in the form of GitHub issues, including bugs and regular issues. Any team member or external stakeholder can author a backlog item. The product owner is responsible for ensuring that all backlog items in a release meet the standards of being ready for development. The standards include: +The backlog is defined in the form of GitHub issues, including bugs and backlog items. Any team member or external stakeholder can author a backlog item. The product owner is responsible for ensuring that all backlog items in a release meet the standards of being ready for development. The standards include: - A clear title -- A concise benefit/result/outcome that defines the benefit someone would receive when the issue is completed. +- A concise benefit/result/outcome that defines the benefit someone would receive when the issue is completed - An optional tag that defines who will benefit from the issue being completed -- A detailed description that contains more context and may contain implementation details. -- A full list of acceptance criteria that clearly define when the issue is complete. -- Scope that is as small as possible and is also a complete and useful new feature for a stakeholder. +- A detailed description that contains more context and may contain implementation details +- A full list of acceptance criteria that clearly define when the issue is complete +- Scope that is as small as possible and is also a complete and useful new feature for a stakeholder #### Triage The product owner is responsible for ensuring that each issue is fully triaged and is either closed or added to a release backlog. Triage with the team primarily happens at the weekly planning meeting and can also happen via GitHub as comments within an issue. -When new issues are added to the GitHub issues list, the product owner makes sure that a `needs triage` label is added so that the issue will be discussed in the next planning meeting. +When new issues are added to the GitHub issues list, the product owner ensures that a `needs triage` label is added so that the issue will be discussed in the next planning meeting. #### Release Definition