From d5bbfe0b05829a666fbac5db13d1f27d444632bb Mon Sep 17 00:00:00 2001 From: JP-Ellis Date: Thu, 18 Jul 2024 08:38:09 +1000 Subject: [PATCH] fix: address comments from @adamrodger Signed-off-by: JP-Ellis --- .github/ISSUE_TEMPLATE/config.yml | 8 ++++ .github/ISSUE_TEMPLATE/tracking-issue.yml | 56 +++++++++++++++++++++++ rfc/0000-rfc-process.md | 5 +- rfc/0000-template.md | 1 + 4 files changed, 68 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/tracking-issue.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..eda0f6c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: ❓ Simple question - Slack chat + url: https://slack.pact.io + about: If you have a simple question, or want to discuss a feature request, join our Slack chat. + - name: ❓ Simple question - Stack Overflow + url: https://stackoverflow.com/questions/tagged/pact + about: The GitHub issue tracker is not for technical support. Please use Stack Overflow, and ask the community for help. diff --git a/.github/ISSUE_TEMPLATE/tracking-issue.yml b/.github/ISSUE_TEMPLATE/tracking-issue.yml new file mode 100644 index 0000000..79517e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/tracking-issue.yml @@ -0,0 +1,56 @@ +name: 🏗️ Tracking Issue +description: A tracking issue to monitor the implementation of an approved RFC. +labels: [tracking] +body: + - type: markdown + attributes: + value: | + This is a tracking issue for an approved RFC. It is expected that the issue will be updated as the implementation progresses. + + Typically, the implementation will require changes across a number of other repositories within the Pact ecosystem. This issue should link to all of these related issues. + + GitHub can automatically monitor the implementation of related issues by using the following markdown: + + ```markdown + - [ ] pact-foundation/{repository}#{issue_number} + ``` + + - type: input + attributes: + label: RFC + description: The RFC number that this issue is tracking. + placeholder: "#123" + validations: + required: true + + - type: textarea + attributes: + label: Summary + description: | + The high-level summary of the feature being implemented. This should be copied from the approved RFC's summary. + validations: + required: true + + - type: textarea + attributes: + label: Implementation Plan + description: | + A plan of how the feature will be implemented. This may vary significantly for different RFCs, but should include a high-level overview of the changes required. + + This plan may be updated as the implementation progresses. + validations: + required: true + + - type: textarea + attributes: + label: Related Issues + description: | + A list of related issues that need to be implemented to complete this RFC. These issues should be linked to this tracking issue. + + GitHub can automatically monitor the implementation of related issues by using the following markdown: + + ```markdown + - [ ] pact-foundation/{repository}#{issue_number} + ``` + + You will need to create these issues in the relevant repositories. diff --git a/rfc/0000-rfc-process.md b/rfc/0000-rfc-process.md index 7eca3a7..f82c96b 100644 --- a/rfc/0000-rfc-process.md +++ b/rfc/0000-rfc-process.md @@ -40,8 +40,9 @@ The RFC process is intended to remain flexible while still ensuring that changes Eventually, a member of the Pact Foundation will either reject the RFC by closing the PR, or accept it by merging the PR. If the RFC is accepted, the following steps will also be taken: -1. Assign an RFC number based on the PR number, and update the filename and metadata. -2. Create a tracking issue in the Pact Foundation Roadmap repository for the implementation of the RFC. Where applicable, other issues may be created in other repositories. +1. Creating a tracking issue in the Pact Foundation Roadmap repository for the implementation of the RFC. +2. Assign an RFC number based on the PR number, and update the filename and metadata (including link to the tracking issue to implementation). +3. Where applicable, other issues may be created in other repositories, with the tracking issue linking to these issues. ## Drawbacks diff --git a/rfc/0000-template.md b/rfc/0000-template.md index 0a912a8..52d6596 100644 --- a/rfc/0000-template.md +++ b/rfc/0000-template.md @@ -2,6 +2,7 @@ name: (fill me in with a unique ident, `my_awesome_feature`) started: (fill me in with today's date, YYYY-MM-DD) pr: pact-foundation/roadmap#0000 +tracking_issue: pact-foundation/roadmap#0000 ---