-
Notifications
You must be signed in to change notification settings - Fork 236
chore: updated JIRA ticket rules to include 3-part RFC tickets #5908
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
f181f6f
e60c243
0548b59
e36e33f
cfe8b0b
f4fde45
9bd72d0
406de59
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,9 +18,9 @@ Output results in the chat window in a way that can be copied and pasted into Ji | |
| Use these syntax rules when writing Jira tickets: | ||
|
|
||
| - `h2.` through `h6.` - Headings (use `h2.` for main, `h3.` for secondary, etc. - avoid `h1.` in descriptions) | ||
| - `{*}{*}` - Bold text | ||
| - `{code}{code}` - Inline code | ||
| - `{code:language}{code}` - Language-specific code blocks | ||
| - `*text*` - Bold text | ||
| - `{{code}}` - Inline code | ||
| - `{code:language}{code}` - Language-specific code blocks, as in `{code:js}{code}` for JavaScript and Typescript code blocks (JIRA doesn't support `{code:typescript}`) | ||
| - `[text|url]` - Links | ||
| - ` - ` - Bullet points | ||
| - `#` - Numbered list items | ||
|
|
@@ -112,6 +112,13 @@ This ticket template is for tracking work for RFCs, new features, new components | |
|
|
||
| Items with an asterisk are optional depending on the context. | ||
|
|
||
| **Note:** For RFC tickets, generate three related tickets that must be completed sequentially: | ||
| 1. RFC authoring and initial review | ||
| 2. Internal discussion shepherding | ||
| 3. External community discussion shepherding | ||
|
|
||
| #### First ticket: RFC authoring | ||
|
|
||
| ``` | ||
| h2. Link to original issue | ||
| (Add a link to the original issue in GitHub if applicable) | ||
|
|
@@ -122,6 +129,13 @@ h2. Overview | |
| h2. Acceptance criteria | ||
| (What is the desired outcome of this RFC or research process? What would make this ticket "done"? What follow-up work would be required? Refer to the RFC guide for examples.) | ||
|
|
||
| Additional acceptance criteria for RFC tickets: | ||
| - RFC has been added to the [Decisions and RFCs wiki|https://wiki.corp.adobe.com/display/AdobeDesign/Decisions+and+RFCs] | ||
| - RFC link has been added to this ticket | ||
| - Announcement posted in {{spectrum-web-reviews}} Slack channel with internal comment deadline (minimum 1 week) | ||
| - Announcement posted in {{spectrum-web-engineering}} Slack channel with internal comment deadline (minimum 1 week) | ||
| - Internal discussion scheduled for SWC team sync after comment period | ||
|
|
||
|
Comment on lines
+132
to
+138
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This work should happen in the first RFC to tee up the work for the second sprint/ticket. |
||
| h2. Estimated internal impact | ||
| (If implemented, what impact would this work have on other APIs, other components, the project structure, or team initiatives? Refer to the impact diagram for details.) | ||
|
|
||
|
|
@@ -141,6 +155,256 @@ h2. Additional context | |
| (Add any other context, drafts, etc. if you have them) | ||
| ``` | ||
|
|
||
| #### Second ticket: Internal discussion shepherding | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This part of the process is the same regardless of RFC topic so we can get away with using a more explicit template that addresses what needs to happen to the RFC rather than what is in the RFC. I left placeholders for updating the name of the RFC that is shepherded as well as the link to the first ticket. |
||
|
|
||
| Title format: `Research: Shepherd [RFC name] RFC through SWC Team Sync discussion` | ||
|
|
||
| **Note:** This ticket must be completed after the first RFC authoring ticket. | ||
|
|
||
| ``` | ||
| h2. Link to RFC | ||
|
|
||
| * RFC authoring Jira Ticket: [ticket URL] | ||
|
|
||
| * Decisions and RFCs wiki: [https://wiki.corp.adobe.com/display/AdobeDesign/Decisions+and+RFCs] | ||
|
|
||
| h2. Overview | ||
|
|
||
| This ticket tracks the work required to shepherd the *[RFC name] RFC* through the internal discussion process and prepare it for external community review. This includes facilitating internal review, updating the RFC based on feedback, scheduling community comment periods, and ensuring proper communication across all relevant channels. | ||
|
|
||
| h2. Acceptance criteria | ||
|
|
||
| - SWC team comments on the RFC have been reviewed and addressed | ||
|
|
||
| - RFC discussion has been facilitated during SWC team sync meeting | ||
|
|
||
| - RFC has been updated based on team discussion feedback | ||
|
|
||
| - RFC is prepared and formatted for external discussion | ||
|
|
||
| - Community comment period of at least two weeks has been scheduled | ||
|
|
||
| - Office hours session has been scheduled following the comment period | ||
|
|
||
| - RFC discussion has been added to the office hours agenda | ||
|
|
||
| - Scheduled comment period and discussion dates have been added to the RFC wiki | ||
|
|
||
| - Announcement has been posted in the {{spectrum-web-components}} Slack channel | ||
|
|
||
| - Announcement has been posted in the {{swc-announcements}} Slack channel | ||
|
|
||
| - Individual consumers who may be impacted have been identified and contacted | ||
|
|
||
| h2. Tasks | ||
|
|
||
| # Review and respond to all SWC team comments on the RFC | ||
|
|
||
| # Facilitate RFC discussion during scheduled SWC team sync | ||
|
|
||
| # Update RFC document based on internal feedback and discussion | ||
|
|
||
| # Prepare RFC for external discussion (formatting, clarity, completeness) | ||
|
|
||
| # Schedule community comment period (minimum 2 weeks) | ||
|
|
||
| # Schedule SWC office hours session after comment period concludes | ||
|
|
||
| # Add RFC discussion to SWC office hours agenda | ||
|
|
||
| # Update RFC wiki with scheduled dates: | ||
|
|
||
| ** Comment period start and end dates | ||
|
|
||
| ** Office hours discussion date | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure how to reference it here, but as per our RFC guidelines, Office Hours is just one opportunity. The idea is use it if there is one available, but don't wait. For example, if there isn't an available office hours or other topics are already scheduled we should schedule an ad hoc review for these discussions. So maybe we don't explicitly call out office hours? Or lean more into "Scheduled Discussion Date" and leave the mechanism up to the RFC driver? |
||
|
|
||
| # Post announcement in {{spectrum-web-components}} Slack channel | ||
|
|
||
| # Post announcement in {{swc-announcements}} Slack channel | ||
|
|
||
| # Identify consumers potentially impacted by the RFC | ||
|
|
||
| # Reach out to impacted consumers individually | ||
|
|
||
| h2. Communication checklist | ||
|
|
||
| h3. SWC Team channels: | ||
|
|
||
| - Slack: {{spectrum-web-reviews}} | ||
|
|
||
| - Slack: {{spectrum-web-engineering}} | ||
|
|
||
| - SWC Team sync discussion (scheduled) | ||
|
|
||
| - SWC Team RFC comment responses | ||
|
|
||
| h3. External channels: | ||
|
|
||
| - Slack: {{spectrum-web-components}} | ||
|
|
||
| - Slack: {{swc-announcements}} | ||
|
|
||
| - Individual consumer outreach | ||
|
|
||
| h3. Documentation: | ||
|
|
||
| - RFC wiki updated with timeline | ||
|
|
||
| - Office hours agenda updated | ||
|
|
||
| h2. Timeline considerations | ||
|
|
||
| - Minimum 2-week community comment period required | ||
|
|
||
| - SWC Office hours must be scheduled for a date after comment period ends | ||
|
|
||
| - Allow time for SWC team updates before opening for community comments | ||
|
|
||
| - Build in buffer time for individual consumer outreach | ||
|
|
||
| h2. Resources | ||
|
|
||
| - [link to RFC] | ||
|
|
||
| - [Decisions and RFCs wiki|https://wiki.corp.adobe.com/display/AdobeDesign/Decisions+and+RFCs] | ||
|
|
||
| - [SWC Office hours agenda|https://adobe.enterprise.slack.com/lists/T024FSURM/F089J8QEZ0V] | ||
|
|
||
| - [SWC Team sync canvas|https://adobe.enterprise.slack.com/docs/T024FSURM/F089Y29EFFH] | ||
| ``` | ||
|
|
||
| #### Third ticket: External community discussion shepherding | ||
|
|
||
| Title format: `Research: Shepherd [RFC name] RFC through Office Hours discussion` | ||
|
|
||
| **Note:** This ticket must be completed after the second internal discussion shepherding ticket. | ||
|
|
||
| ``` | ||
| h2. Link to RFC | ||
|
|
||
| * RFC authoring Jira Ticket: [link to RFC ticket] | ||
|
|
||
| * Decisions and RFCs wiki: [https://wiki.corp.adobe.com/display/AdobeDesign/Decisions+and+RFCs] | ||
|
|
||
| h2. Overview | ||
|
|
||
| This ticket tracks the work required to shepherd the *[RFC name] RFC* through the community discussion process and to finalize the decision. This includes monitoring and responding to community feedback during the comment period, facilitating discussion during office hours, documenting the final decision, and creating follow-up implementation tickets. | ||
|
|
||
| h2. Acceptance criteria | ||
|
|
||
| * All community comments on the RFC have been reviewed and responded to | ||
|
|
||
| * RFC discussion has been facilitated during SWC office hours | ||
|
|
||
| * RFC has been updated based on community discussion feedback and final decisions | ||
|
|
||
| * RFC is prepared and formatted for community discussion | ||
|
|
||
| * RFC status and decision have been updated on the [Decisions and RFCs wiki|https://wiki.corp.adobe.com/display/AdobeDesign/Decisions+and+RFCs] | ||
|
|
||
| * Follow-up implementation tickets have been created for the agreed-upon course of action | ||
|
|
||
| * Implementation tickets are linked to this RFC ticket | ||
|
|
||
| h2. Tasks | ||
|
|
||
| # Review and respond to all community comments on the RFC | ||
|
|
||
| # Facilitate RFC discussion during scheduled SWC office hours | ||
|
|
||
| # Update RFC document based from scheduled SWC office hours: | ||
|
|
||
| ## Key discussion points, concerns, and consensus | ||
|
|
||
| ## Final decisions from discussion | ||
|
|
||
| ## Implementation approach | ||
|
|
||
| ## Timeline considerations | ||
|
|
||
| # Create follow-up tickets for implementation work | ||
|
|
||
| # Link implementation tickets to the RFC | ||
|
|
||
| # Update Decisions and RFCs wiki with: | ||
|
|
||
| ## RFC status (Accepted/Rejected/Modified) | ||
|
|
||
| ## Final decision and rationale | ||
|
|
||
| ## Implementation plan | ||
|
|
||
| ## Link to follow-up tickets | ||
|
|
||
| h2. Discussion facilitation notes | ||
|
|
||
| h3. Before office hours: | ||
|
|
||
| * Review all community comments | ||
|
|
||
| * Identify key questions or concerns to address | ||
|
|
||
| * Prepare any examples or demonstrations needed | ||
|
|
||
| * Coordinate with relevant team members | ||
|
|
||
| h3. During office hours: | ||
|
|
||
| * Present RFC overview and context | ||
|
|
||
| * Address questions and concerns from attendees | ||
|
|
||
| * Guide discussion toward consensus | ||
|
|
||
| * Document decisions and action items | ||
|
|
||
| * Clarify next steps | ||
|
|
||
| h3. After office hours: | ||
|
|
||
| * Create follow-up tickets for implementation work | ||
|
|
||
| * Update RFC with final decisions | ||
|
|
||
| * Update Decisions and RFCs wiki page | ||
|
|
||
| h2. Documentation updates | ||
|
|
||
| h3. RFC document: | ||
|
|
||
| * Status: (Accepted/Rejected/Pending) | ||
|
|
||
| * community feedback summary | ||
|
|
||
| * Final decision rationale | ||
|
|
||
| * Implementation timeline | ||
|
|
||
| h3. Wiki page: | ||
|
|
||
| * Decision status and date | ||
|
|
||
| * Link to implementation tickets | ||
|
|
||
| h3. Implementation tickets: | ||
|
|
||
| * Reference to the RFC | ||
|
|
||
| * Specific acceptance criteria from RFC decisions | ||
|
|
||
| * Priority and timeline alignment | ||
|
|
||
| * Dependencies between implementation tasks | ||
|
|
||
| h2. Resources | ||
|
|
||
| * [link to RFC] | ||
|
|
||
| * [Decisions and RFCs wiki|https://wiki.corp.adobe.com/display/AdobeDesign/Decisions+and+RFCs] | ||
|
|
||
| * [SWC Office hours agenda|https://adobe.enterprise.slack.com/lists/T024FSURM/F089J8QEZ0V] | ||
| ``` | ||
|
|
||
| ## Severity classification | ||
|
|
||
| - SEV1: Critical - System down, data loss, security breach | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Expands JIRA RFCs from a single ticket into three related tickets.