Skip to content

Commit

Permalink
Merge pull request #85 from alphagov/create-issues-template
Browse files Browse the repository at this point in the history
Create issues template
  • Loading branch information
nnagewad authored Oct 16, 2024
2 parents 75304fc + c2ff4b7 commit ca16987
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/01-new-component.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: New component
description: Document a component that needs to be added to the GOV.UK Publishing Design Guide
title: "Document [Enter the name of the component]"
labels: ["component", "new documentation"]
projects: ["alphagov/99"]
body:
- type: markdown
attributes:
value: "# Steps to start documenting a new component"
- type: markdown
attributes:
value: |
- Assign yourself to this issue
- Under the "Development" select the "Create a new branch" to start documenting the new component
- Be sure to check the following criterias:
- **Repository destination** is set to `alphagov/govuk-design-guide`
- **Branch source** is set to `main`
- Select "Checkout locally", which will automatically create a new branch related to this issue
- Once selected, copy the command and run it in your VS Code terminal
- Confirm that you are working on the new branch by selecting the branch icon in the bottom left corner of VS Code
- Start documenting the new component be sure to duplicate the template file `*component-documentation-template` and rename it to the component
- **Note:** spaces are replaced with hyphens (ie. `-`)
- There may be existing documentation for this component. Please refer to:
- [Version 2.0 of documentation](https://docs.google.com/document/d/1AxlM2W9tu3su7K3nlqPhqNK1HoZwQIZaHf4Cv3TRHNg/edit?usp=sharing)
- [Version 3.0 of documentation](https://docs.google.com/document/d/1hFs6afjEPgQe5Wh2xq1H7RhzT-0OhMyHKi-NsODLDRY/edit?usp=sharing)
- [Version 4.0 of documentation](https://docs.google.com/document/d/1Fb6Vv-QS5tuYqhCYBcpGIaTNt4zDBeBMznz-7Nch-lE/edit?usp=sharing)
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/02-new-pattern.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: New pattern
description: Document a pattern that needs to be added to the GOV.UK Publishing Design Guide
title: "Document [Enter the name of the pattern]"
labels: ["pattern", "new documentation"]
projects: ["alphagov/99"]
body:
- type: markdown
attributes:
value: "# Steps to start documenting a new pattern"
- type: markdown
attributes:
value: |
- Assign yourself to this issue
- Under the "Development" select the "Create a new branch" to start documenting the new pattern
- Be sure to check the following criterias:
- **Repository destination** is set to `alphagov/govuk-design-guide`
- **Branch source** is set to `main`
- Select "Checkout locally", which will automatically create a new branch related to this issue
- Once selected, copy the command and run it in your VS Code terminal
- Confirm that you are working on the new branch by selecting the branch icon in the bottom left corner of VS Code
- Start documenting the new pattern be sure to duplicate the template file `*pattern-documentation-template` and rename it to the component
- **Note:** spaces are replaced with hyphens (ie. `-`)
- There may be existing documentation for this pattern. Please refer to:
- [Version 2.0 of documentation](https://docs.google.com/document/d/1AxlM2W9tu3su7K3nlqPhqNK1HoZwQIZaHf4Cv3TRHNg/edit?usp=sharing)
- [Version 3.0 of documentation](https://docs.google.com/document/d/1hFs6afjEPgQe5Wh2xq1H7RhzT-0OhMyHKi-NsODLDRY/edit?usp=sharing)
- [Version 4.0 of documentation](https://docs.google.com/document/d/1Fb6Vv-QS5tuYqhCYBcpGIaTNt4zDBeBMznz-7Nch-lE/edit?usp=sharing)
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/03-new-frontend-template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: New frontend template
description: Document a frontend template that needs to be added to the GOV.UK Publishing Design Guide
title: "Document [Enter the name of the frontend template]"
labels: ["frontend template", "new documentation"]
projects: ["alphagov/99"]
body:
- type: markdown
attributes:
value: "# Steps to start documenting a new frontend template"
- type: markdown
attributes:
value: |
- Assign yourself to this issue
- Under the "Development" select the "Create a new branch" to start documenting the new frontend template
- Be sure to check the following criterias:
- **Repository destination** is set to `alphagov/govuk-design-guide`
- **Branch source** is set to `main`
- Select "Checkout locally", which will automatically create a new branch related to this issue
- Once selected, copy the command and run it in your VS Code terminal
- Confirm that you are working on the new branch by selecting the branch icon in the bottom left corner of VS Code
- Start documenting the new frontend template be sure to duplicate the template file `*frontend-template-documentation-template` and rename it to the component
- **Note:** spaces are replaced with hyphens (ie. `-`)
- There may be existing documentation for this frontend template. Please refer to:
- [Version 2.0 of documentation](https://docs.google.com/document/d/1AxlM2W9tu3su7K3nlqPhqNK1HoZwQIZaHf4Cv3TRHNg/edit?usp=sharing)
- [Version 3.0 of documentation](https://docs.google.com/document/d/1hFs6afjEPgQe5Wh2xq1H7RhzT-0OhMyHKi-NsODLDRY/edit?usp=sharing)
- [Version 4.0 of documentation](https://docs.google.com/document/d/1Fb6Vv-QS5tuYqhCYBcpGIaTNt4zDBeBMznz-7Nch-lE/edit?usp=sharing)

0 comments on commit ca16987

Please sign in to comment.