Skip to content

Commit

Permalink
📖 Migrate Intent-to-* issue templates to yaml forms (#34431)
Browse files Browse the repository at this point in the history
  • Loading branch information
rsimha committed May 18, 2021
1 parent cfc5d28 commit fe4e10f
Show file tree
Hide file tree
Showing 10 changed files with 243 additions and 223 deletions.
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/bug-report.yml
@@ -1,6 +1,6 @@
---
name: Bug Report
description: Used to report bugs in AMP.
description: Report a bug in AMP.
labels: "Type: Bug"
body:
- type: markdown
Expand All @@ -16,23 +16,23 @@ body:
id: description
attributes:
label: Description
description: Briefly describe the bug.
placeholder: Describing the expected vs. the current behavior will help us direct this issue to the correct working group for investigation.
description: A brief description of the bug.
placeholder: Describe the expected vs. the current behavior, so this issue can be directed to the correct working group for investigation.
validations:
required: true
- type: textarea
id: repro_steps
attributes:
label: Reproduction Steps
description: Provide step-by-step instructions for reproducing the issue.
placeholder: Please provide a public URL and ideally a reduced test case that clearly demonstrates your issue.
description: Step-by-step instructions for reproducing the issue.
placeholder: Provide a publicly accessible URL and a reduced set of steps that clearly demonstrate the issue.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant Logs
description: Optionally paste any relevant log output here.
description: Relevant logging output.
placeholder: Paste any plain-text logs here (e.g. console warnings or errors from Chrome DevTools). They will automatically be formatted as code.
render: shell
- type: dropdown
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/feature-request.yml
@@ -1,6 +1,6 @@
---
name: Feature Request
description: Used to report a feature request for AMP.
description: Request a new feature in AMP.
labels: "Type: Feature Request"
body:
- type: markdown
Expand All @@ -16,21 +16,21 @@ body:
id: description
attributes:
label: Description
description: Briefly describe the feature request.
description: A brief description of the feature request.
placeholder: Provide a clear and concise description of the new feature or change to an existing feature you'd like to see.
validations:
required: true
- type: textarea
id: alternatives_considered
attributes:
label: Alternatives Considered
description: Describe any alternatives you've considered.
description: Alternatives to this feature request.
placeholder: Provide details around any alternative solutions or features you've considered.
validations:
required: true
- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Add any other context here.
description: Other relevant context.
placeholder: Add any other context about your feature request here. E.g. paste a screenshot, or provide a link.
52 changes: 0 additions & 52 deletions .github/ISSUE_TEMPLATE/intent-to-deprecate--i2d-.md

This file was deleted.

57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/intent-to-deprecate.yml
@@ -0,0 +1,57 @@
---
name: Intent-to-Deprecate (I2D)
description: Propose that an existing AMP feature be deprecated.
labels: INTENT TO DEPRECATE
body:
- type: markdown
id: header
attributes:
value: |
Thanks for creating this Intent-to-Deprecate (I2D) issue.
- See AMP's [versioning and deprecations policy](https://github.com/ampproject/amphtml/blob/main/docs/spec/amp-versioning-policy.md) for instructions on how to fill out this I2D template and how to get help.
- If the feature can be removed immediately after deprecation, add the "INTENT TO REMOVE" label to this issue.
- Otherwise, file a separate Intent-to-Remove (I2R) when the feature is ready for removal.
- type: textarea
id: summary
attributes:
label: Summary
description: A brief description of the feature to be deprecated.
placeholder: Provide the detailed removal plan if the feature is ready for immediate removal after deprecation. Otherwise provide an initial plan for removing the deprecated feature and file a separate Intent-to-Remove (I2R) issue after this issue is approved.
validations:
required: true
- type: textarea
id: motivation
attributes:
label: Motivation
description: The rationale behind this deprecation.
placeholder: Explain why this feature needs to be deprecated and eventually removed.
validations:
required: true
- type: textarea
id: impact
attributes:
label: Impact on Existing Users
description: How this will affect existing users.
placeholder: Explain how the removal of this feature will affect sites that currently use AMP. If available, provide the estimated usage of this feature.
validations:
required: true
- type: textarea
id: alternative_implementation
attributes:
label: Alternative Implementation
description: Alternative implementation suggestions for developers using AMP.
placeholder: Explain how developers using AMP can achieve similar functionality after the feature you are deprecating is removed.
validations:
required: true
- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Any other relevant context.
placeholder: Add any other context that may help people understand your I2D. E.g. paste a screenshot, or provide a link.
- type: textarea
id: notifications
attributes:
label: Notifications
description: Add working groups or individuals you want to notify about this I2D.
value: /cc @ampproject/wg-approvers
55 changes: 0 additions & 55 deletions .github/ISSUE_TEMPLATE/intent-to-implement--i2i-.md

This file was deleted.

56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/intent-to-implement.yml
@@ -0,0 +1,56 @@
---
name: Intent-to-Implement (I2I)
description: Propose a significant feature or change to AMP.
labels: INTENT TO IMPLEMENT
body:
- type: markdown
id: header
attributes:
value: |
Thanks for creating this Intent-to-Implement (I2I) issue.
- See AMP's [code contribution guide](https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md) for instructions on how to fill out this I2I form and how to get help.
- Note that if you are implementing a minor change or fix, you likely do not need to file an I2I.
- If you haven't already done so, sign AMP's [Contributor License Agreement (CLA)](https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md#contributor-license-agreement).
- A signed CLA is not required to submit this I2I or to create a PR, but is required before code can be merged.
- type: textarea
id: summary
attributes:
label: Summary
description: A brief description of the feature being implemented.
placeholder: Provide a brief description of the feature you are planning on implementing.
validations:
required: true
- type: textarea
id: design_doc
attributes:
label: Design Document
description: Document that describes the feature's design.
placeholder: Provide a link to your design document once you have one. You do not need a design document to file this I2I.
- type: textarea
id: motivation
attributes:
label: Motivation
description: The rationale behind this feature.
placeholder: Explain why AMP needs this change. It may be useful to describe what AMP developers/users are forced to do without it. When possible, include links to back up your claims.
validations:
required: true
- type: textarea
id: alternative_solutions
attributes:
label: Alternative Solutions
description: Alternative solutions for developers using AMP.
placeholder: Provide a clear and concise description of any alternative solutions or features you've considered.
validations:
required: true
- type: textarea
id: launch_tracker
attributes:
label: Launch Tracker
description: A tracker for the project's status.
placeholder: Provide a link to the launch tracker for this work here if applicable. A template with instructions can be found at bit.ly/amp-launch-tracker.
- type: textarea
id: notifications
attributes:
label: Notifications
description: Add working groups or individuals you want to notify about this I2I, including a code reviewer once you have found one. See [here](https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md) for help.
value: /cc @ampproject/wg-approvers
48 changes: 0 additions & 48 deletions .github/ISSUE_TEMPLATE/intent-to-remove--i2r-.md

This file was deleted.

55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/intent-to-remove.yml
@@ -0,0 +1,55 @@
---
name: Intent-to-Remove (I2R)
description: Propose a rollout plan for the removal of a deprecated feature.
labels: INTENT TO REMOVE
body:
- type: markdown
id: header
attributes:
value: |
Thanks for creating this Intent-to-Remove (I2R) issue.
- See AMP's [versioning and deprecations policy](https://github.com/ampproject/amphtml/blob/main/docs/spec/amp-versioning-policy.md) for instructions on how to fill out this I2R template and how to get help.
- This I2R issue should be created after the Intent-to-Deprecate (I2D) issue for the feature was approved.
- type: textarea
id: summary
attributes:
label: Summary
description: A brief description of the feature being removed.
placeholder: Provide a brief description of the feature you are planning on removing.
validations:
required: true
- type: textarea
id: i2d_issue
attributes:
label: Intent-to-Deprecate (I2D) Issue
description: A link to the I2D issue.
placeholder: Provide a link to the I2D issue you filed to deprecate this feature.
validations:
required: true
- type: textarea
id: rollout_plan
attributes:
label: Rollout Plan
description: Steps to remove the feature.
placeholder: Provide details for the steps you will use to remove this previously deprecated feature.
validations:
required: true
- type: textarea
id: alternative_implementation
attributes:
label: Alternative Implementation
description: Alternative implementation suggestions for developers using AMP.
placeholder: Explain how developers using AMP can achieve similar functionality after the feature you are deprecating is removed.
validations:
required: true
- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Any other relevant context.
- type: textarea
id: notifications
attributes:
label: Notifications
description: Add working groups or individuals you want to notify about this I2I.
value: /cc @ampproject/wg-approvers

0 comments on commit fe4e10f

Please sign in to comment.