Skip to content

Commit

Permalink
fix: address comments from @adamrodger
Browse files Browse the repository at this point in the history
Signed-off-by: JP-Ellis <[email protected]>
  • Loading branch information
JP-Ellis committed Jul 17, 2024
1 parent 45412e4 commit dbdb24a
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 2 deletions.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/tracking-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
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.
5 changes: 3 additions & 2 deletions rfc/0000-rfc-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions rfc/0000-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
<!--
The following is a template to help you write your RFC. You don't have to strictly follow this template, but it should help you to consider the various aspects of your proposal. If you have any questions, feel free to ask in the PR or in the Pact Slack community.
Expand Down

0 comments on commit dbdb24a

Please sign in to comment.