Skip to content

Commit

Permalink
Update issue templates to be consistent with governance
Browse files Browse the repository at this point in the history
  • Loading branch information
e-lo committed Jan 13, 2024
1 parent ba6d670 commit 1f4d6e1
Show file tree
Hide file tree
Showing 8 changed files with 164 additions and 72 deletions.
13 changes: 10 additions & 3 deletions .github/ISSUE_TEMPLATE/code_bug.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
---
name: Code bug report
about: Create a report to help us improve the project code
title: '🐛💻 – '
title: '🐛💻 '
labels: ['💻 code', '🐛 bug']
assignees: ''

---

**Describe the problem**
## What's the problem?
<!-- A clear and concise description of the problem, what result did you expect, what did you get? -->

**Steps to reproduce**
## Thoughts about what is going on

## Steps to reproduce and/or test that it is solved
<!-- Describe the steps required to reproduce the problem, see <https://stackoverflow.com/help/minimal-reproducible-example> -->

## Non-normative Change Process

- [ ] Submit change as a PR to `main` branch that will pass tests.
- [ ] PRs MUST be reviewed and approved in GitHub by 2+ members of the board – or their designees – for accuracy and consistency with the changes’ intent.
31 changes: 12 additions & 19 deletions .github/ISSUE_TEMPLATE/code_feature.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,24 @@
---
name: Code feature request
about: Suggest and idea for the project code
title: '🚀💻 – '
labels: ['💻 code', '🚀 feature']
title: '🚀💻 '
labels: ['💻 code', '🚀 feature', '📝 non-normative']
assignees: ''

---

<!--
Steps to implementing a code feature request
1. Create an issue for the feature request (you're in the right place!)
2. Fact-finding: Describe potential solutions and recommend one.
3. Build consensus around a single solution.
4. Implement the change in a pull-request.
5. Follow governance process for pull-request approval.
-->

**Describe the feature you want and how it meets your needs or solves a problem**
## User Story
<!-- Describe the feature you want and how it meets your needs or solves a problem-->
<!-- Your user story, https://tech.gsa.gov/guides/effective_user_stories/ -->
As a <!-- type of user -->, I want <!-- some goal, function --> so that <!-- some reason -->.

**Describe the solution you'd like**
<!-- A clear and concise description of what you want to happen. -->

**Describe alternatives you've considered**
## Context
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
<!-- Add any other context or data samples for the feature request here. -->

## Solution Development

## Non-normative Change Process

**Additional context**
<!-- Add any other context for the feature request here. -->
- [ ] Submit change as a PR to `main` branch that will pass tests.
- [ ] PRs MUST be reviewed and approved in GitHub by 2+ members of the board – or their designees – for accuracy and consistency with the changes’ intent.
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/spec_bug.md

This file was deleted.

32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/spec_feature.md

This file was deleted.

27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/spec_non-normative.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Non-normative change to specification
about: This would be a [**non-normative content change**](https://tides-transit.org/main/governance/policies/change-management/#normative-content) to the spec.
title: '📝 '
labels: ['📄 spec', '🚀 feature', '📝 non-normative']
assignees: ''

---

- [ ] Meets requirement of a [**non-normative changes**](https://tides-transit.org/main/governance/policies/change-management/#normative-content) which can be implemented with a pull-request that is approved by 2+ members of the TIDES Board – or their designees – for accuracy and consistency with the changes’ intent.

## User Story
<!-- Describe the feature you want and how it meets your needs or solves a problem-->
<!-- Your user story, https://tech.gsa.gov/guides/effective_user_stories/ -->
As a <!-- type of user -->, I want <!-- some goal, function --> so that <!-- some reason -->.

## Context
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
<!-- Add any other context or data samples for the feature request here. -->

## Solution Ideas
<!-- A clear and concise description of what you want to happen, if you know. -->

## Non-normative Change Process

- [ ] Submit change as a PR to `main` branch.
- [ ] PRs MUST be reviewed and approved in GitHub by 2+ members of the board – or their designees – for accuracy and consistency with the changes’ intent.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/spec_normative.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Normative change to specification
about: This would require a [**normative content change**](https://tides-transit.org/main/governance/policies/change-management/#normative-content) to the spec, requiring the [official change-making process](https://tides-transit.org/main/governance/policies/change-management/#change-making-stages).
title: '🔄 '
labels: ['📄 spec', '🚀 feature', '🔄 normative change']
assignees: ''
---

- [ ] This would require a [**normative content change**](https://tides-transit.org/main/governance/policies/change-management/#normative-content) to the spec, requiring the [official change-making process](https://tides-transit.org/main/governance/policies/change-management/#change-making-stages).

## User Story
<!-- Describe the feature you want and how it meets your needs or solves a problem-->
<!-- Your user story, https://tech.gsa.gov/guides/effective_user_stories/ -->
As a <!-- type of user -->, I want <!-- some goal, function --> so that <!-- some reason -->.

## Context
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
<!-- Add any other context or data samples for the feature request here. -->

## Working Group Members
<!-- Issue submitter may suggest, but nomination is up to the TIDES Manager. -->
*The TIDES Manager will invite those who have expressed interest in the issue (including the issue creator and commenters) and who they believe will have an interest in the topic to take part on the Issue Working Group. They will also solicit participation from all TIDES Contributors.*

## Solution Ideas

<!-- A clear and concise description of what you want to happen, if you know. -->

## Normative Change Process

## Preparation

- [ ] TIDES Manager has convened an Issue Working Group.
- [ ] Working Group members document discussion points in this issue.

## Resolution

- [ ] Working Group members reach consensus.

*OR*

- [ ] While consensus will be sought, if the Working Group members cannot come to a unanimous agreement about the solution, the TIDES Manager may ask the TIDES Board to make a decision after hearing feedback from various perspectives.

## Implementation

- [ ] Working Group members update the schema and documentation according to the proposal on a feature branch and submit a pull request to the develop branch.
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/spec_urgent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
name: Data specification feature request
about: An [**urgent need**](https://tides-transit.org/main/governance/policies/change-management/#expedited-change-management) for a [**normative change**](https://tides-transit.org/main/governance/policies/change-management/#normative-content) to the TIDES Specification which is critical to maintaining the security, compliance, or operational functionality of TIDES which should go through the [expedited change-making process](https://tides-transit.org/main/governance/policies/change-management/#expedited-change-management).
title: ''
labels: ['📄 spec', '🚀 feature', '❗ Urgent', '🔄 normative change']
assignees: ''

---

[ ] Meets the requirements for an [**urgent need**](https://tides-transit.org/main/governance/policies/change-management/#expedited-change-management) critical to maintaining the security, compliance, or operational functionality of TIDES.
[ ] Meets requirement of a [**normative content change**](https://tides-transit.org/main/governance/policies/change-management/#normative-content) – otherwise, can open a non-normative change which is much easier.

### Urgency Justification
<!-- What is risk of not addressing this urgently -->

## User Story
<!-- Describe the feature you want and how it meets your needs or solves a problem-->
<!-- Your user story, https://tech.gsa.gov/guides/effective_user_stories/ -->
As a <!-- type of user -->, I want <!-- some goal, function --> so that <!-- some reason -->.

## Context
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
<!-- Add any other context or data samples for the feature request here. -->

## Working Group Members
<!-- Issue submitter may suggest, but nomination is up to the TIDES Manager. -->
*The TIDES Manager MUST convene a group of at least 2 TIDES Contributors of their choosing to swiftly assess the issue’s urgency and validity.*

- *The Urgent Working Group Members SHOULD contain representatives of TIDES Contributors affected stakeholder groups.*
- *The Urgent Working Group size SHOULD be at least three and reflect the scale of the problem and also need for agile decision making.*

## Solution Ideas
<!-- A clear and concise description of what you want to happen, if you know. -->

## Expedited Change Process Progress

### TIDES Manager Approves Proceeding

- [ ] TIDES Manager confirms meets threshold for an urgent need.
- [ ] TIDES Manager proposes Urgent Working Group Members to the TIDES Board.

### TIDES Board Approves Proceeding

- [ ] TIDES Board confirms need is urgent.
- [ ] TIDES Board confirms Urgent Working Group Membership.

*OR*

- [ ] If the TIDES Board fails to respond within 48 hours, the Urgent Working Group MAY proceed with their implicit approval.

### Solution Identification

- [ ] Urgent Working Group, managed by the TIDES Manager identifies a solution agreed to by a supermajority of the Urgent Working Group members.
- [ ] If the decision is deadlocked, the decision is escalated to the TIDES Board.
- [ ] Board approves a solution.
- [ ] Approved solution documented as a PR to the main repository branch
15 changes: 14 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,16 @@
- [ ] Relevant documentation updated
- [ ] Certify to the Developer Certificate of Origin in [CONTRIBUTING.md](CONTRIBUTING.md#contributor-agreement).

### Checklist for changes in `/samples` or `/spec`
## Checklist for changes in `/samples` or `/spec`
<!-- Delete if not relevant -->
- [ ] Ran `tests/test_local_spec` script to check and fix formatting, validate profile and schemas with frictionless and with each other, and confirm that documentation can be built locally.
- [ ] Ran `tests/test_samples_to_local` script to check if samples conform to any changes to the spec.

## Checklist for **non-normative changes
<!-- Delete if not relevant -->
- [ ] Meets requirement of a [**non-normative changes**](https://tides-transit.org/main/governance/policies/change-management/#normative-content)
- [ ] PR Approved by 2+ members of the TIDES Board – or their designees – for accuracy and consistency with the changes’ intent.

## Checklist for **normative** changes
<!-- Delete if not relevant -->

Expand Down Expand Up @@ -53,3 +58,11 @@ If any reviewer requests substantial changes, they must also agree to work with
- [ ] Alternative solution being developed.
- [ ] Working Group does not agree with the suggested change and appeal submitted to the TIDES Board.
- [ ] TIDES Board approves this change.

## Checklist for **expedited** change
<!-- Delete if not relevant -->

- [ ] A supermajority of the Urgent Working Group members have approve the proposed change to meet the urgent need.
- [ ] If the decision is deadlocked, the decision is escalated to the TIDES Board.
- [ ] TIDES Board approves this change.

0 comments on commit 1f4d6e1

Please sign in to comment.