Skip to content
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

Add issue templates, footer and contact us page #125

Merged
merged 23 commits into from
Jul 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/accessibility_issue.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: ♿ Accessibility Issue
description: Report an accessibility or usability issue.
title: '[accessibility]: '
labels: 'type: accessibility, awaiting triage'
body:
- type: markdown
attributes:
value: '## Welcome!'
- type: markdown
attributes:
value: Thanks for taking the time to fill out this accessibility report.
- type: markdown
attributes:
value: Please fill in as much of the template below as you're able to. If you're unsure whether the issue already exists or how to fill in the template, open an issue anyway. Our team will help you to complete the rest.
- type: markdown
attributes:
value: Your issue might already exist. If so, add a comment to the existing issue instead of creating a new one. You can [find existing issues here](https://github.com/nhsuk/nhsapp-frontend/issues).
- type: dropdown
id: browser
attributes:
label: Browser
description: Which browser(s) are you experiencing the issue?
multiple: true
options:
- Chrome
- Safari
- Firefox
- Edge
- type: dropdown
id: os
attributes:
label: Operating System
description: Which operating system are you using?
multiple: true
options:
- Windows
- MacOS
- Other
- type: input
id: version
attributes:
label: NHS App Frontend version
description: 'Which version(s) of the NHS App Frontend are you using? This can be found in your package.json file.'
placeholder: e.g. v1.2.0
- type: input
id: technology
attributes:
label: Assistive technology
description: 'Did you experience the issue using an assistive technology?'
placeholder: e.g. JAWS, MacOS VoiceOver
- type: textarea
id: description
attributes:
label: Description
description: "Tell us more about the accessibility issue that you're experiencing"
placeholder: What did you expect to happen? What happened instead?
validations:
required: true
- type: input
id: wcag
attributes:
label: WCAG 2.2 Violation
description: 'Does this violate a specific WCAG 2.2 checkpoint?'
placeholder: e.g Success Criterion 1.4.3 Contrast (Minimum)
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce
description: 'How do we reproduce the accessibility issue you described?'
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: 🐛 Bug report
description: Something not working as expected? This is the place to report your issue.
title: '[Bug]: '
labels: 'type: bug, awaiting triage'
body:
- type: markdown
attributes:
value: '## Welcome!'
- type: markdown
attributes:
value: Thanks for taking the time to fill out this bug report.
- type: markdown
attributes:
value: Please fill in as much of the template below as you're able to. If you're unsure whether the issue already exists or how to fill in the template, open an issue anyway. Our team will help you to complete the rest.
- type: markdown
attributes:
value: Your issue might already exist. If so, add a comment to the existing issue instead of creating a new one. You can [find existing issues here](https://github.com/nhsuk/nhsapp-frontend/issues).
- type: dropdown
id: browser
attributes:
label: Browser
description: Which browser(s) are you experiencing the issue?
multiple: true
options:
- Chrome
- Safari
- Firefox
- Edge
- type: input
id: version
attributes:
label: NHS App Frontend version
description: 'Which version(s) of the NHS App Frontend are you using? This can be found in your package.json file.'
placeholder: e.g. v1.2.0
- type: textarea
id: description
attributes:
label: Description
description: "Tell us more about the problem that you're running into"
placeholder: What did you see? What did you expect to see?
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce
description: 'How do we reproduce the error you described using the
reproduction/example link above?'
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Get in touch another way
url: https://design-system.nhsapp.service.nhs.uk/help-and-feedback/
about: Find out how to get in touch via email or Slack.
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/design_defect.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: 🎨 Design defect
description: Report a visual design issue
title: '[Bug]: '
labels: 'type: bug, awaiting triage'
body:
- type: markdown
attributes:
value: '## Welcome!'
- type: markdown
attributes:
value: Thanks for taking the time to fill out the details below for this design defect.
- type: markdown
attributes:
value: Please fill in as much of the template below as you're able to. If you're unsure whether the issue already exists or how to fill in the template, open an issue anyway. Our team will help you to complete the rest.
- type: markdown
attributes:
value: Your issue might already exist. If so, add a comment to the existing issue instead of creating a new one. You can [find existing issues here](https://github.com/nhsuk/nhsapp-frontend/issues).
- type: dropdown
id: browser
attributes:
label: Browser
description: Which browser(s) are you experiencing the issue?
multiple: true
options:
- Chrome
- Safari
- Firefox
- Edge
- type: input
id: version
attributes:
label: NHS App Frontend version
description: 'Which version(s) of the NHS App Frontend are you using? This can be found in your package.json file.'
placeholder: e.g. v1.2.0
- type: textarea
id: description
attributes:
label: Description
description: "Tell us more about the problem that you're running into"
placeholder: What did you see? What did you expect to see?
validations:
required: true
- type: textarea
id: example-url
attributes:
label: Screenshots
description: 'Provide screenshots of the problem'
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce
description: 'How do we reproduce the problem displayed in the screenshots above?'
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: 📖 Documentation
description: Add new documentation, or report missing, incorrect or unclear documentation
title: '[Documentation]: '
labels: 'type: documentation, awaiting triage'
body:
- type: markdown
attributes:
value: '## Welcome!'
- type: markdown
attributes:
value: Thanks for taking the time to fill out the details below for documentation.
- type: markdown
attributes:
value: Please fill in as much of the template below as you're able to. If you're unsure whether the issue already exists or how to fill in the template, open an issue anyway. Our team will help you to complete the rest.
- type: markdown
attributes:
value: Your issue might already exist. If so, add a comment to the existing issue instead of creating a new one. You can [find existing issues here](https://github.com/nhsuk/nhsapp-frontend/issues).
- type: textarea
id: description
attributes:
label: Description
description: 'Tell us more about the proposal or problem.'
validations:
required: true
- type: textarea
id: example-url
attributes:
label: Related documentation
description: 'Does this issue refer to a gap or mistake in some existing documentation? Provide a link if possible.'
- type: textarea
id: evidence
attributes:
label: Evidence (where applicable)
description: 'Please provide any relevant user research or evidence to support this change.'
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/new_component_or_pattern.md

This file was deleted.

44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/new_feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: ✨ Feature request
description: Suggest a new feature or idea
title: '[Feature request]: '
labels: 'type: feature request, awaiting triage'
body:
- type: markdown
attributes:
value: '## Welcome!'
- type: markdown
attributes:
value: Thanks for taking the time to fill out the details below for this new feature or idea.
- type: markdown
attributes:
value: Please fill in as much of the template below as you're able to. If you're unsure whether the issue already exists or how to fill in the template, open an issue anyway. Our team will help you to complete the rest.
- type: markdown
attributes:
value: Your issue might already exist. If so, add a comment to the existing issue instead of creating a new one. You can [find existing issues here](https://github.com/nhsuk/nhsapp-frontend/issues).
- type: textarea
id: description
attributes:
label: Description
description: 'Briefly describe the thing.'
validations:
required: true
- type: textarea
id: related
attributes:
label: Related component
description: 'Does this feature relate to an existing component?'
- type: textarea
id: context
attributes:
label: Context
description: 'What are you trying to do? Is this something you think should behave differently, or something that you currently cannot do? Is this related to an existing issue/bug?'
- type: textarea
id: Alternatives
attributes:
label: Alternatives
description: 'Are you currently using a workaround / alternative solution instead?'
- type: textarea
id: additional
attributes:
label: Additional information (if applicable)
description: "What evidence do you have that this meets the needs of users? It's useful for us to know of any user research/testing you've done with this feature."
23 changes: 21 additions & 2 deletions docs/_includes/layouts/base.njk
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,14 @@

{% block header %}
{{ header({
"service": {
"name": "App design resources"
},
"showNav": "false",
"showSearch": "false",
"homeHref": baseUrl
"homeHref": baseUrl,
"classes": "app-header",
"ariaLabel": "NHS App design resources homepage"
}) }}
{% endblock %}

Expand All @@ -47,7 +52,21 @@
</div>
{% endblock container %}

{% block footer %}{% endblock %}
{% block footer %}

{{ footer({
"links": [
{
"URL": "/help-and-feedback/",
"label": "Help and feedback"
},
{
"URL": "https://github.com/nhsuk/nhsapp-frontend",
"label": "Code on Github"
}
]
})}}
{% endblock %}

{% endblock body %}
</body>
Expand Down
6 changes: 1 addition & 5 deletions docs/_includes/layouts/partials/feedback-section.njk
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
<h2>Help improve this component</h2>
<p>If you have used or researched this component, please let us know what you found so we can make it better for everyone.</p>
<p><a href="https://github.com/nhsuk/nhsapp-frontend/issues/{{ backlogID }}">Discuss '{{ title }}' on GitHub</a> where you can share anything you think might be useful.</p>
<p>Or you can use:</p>
<ul>
<li><a href="https://nhsdigitalcorporate.enterprise.slack.com/archives/C06GY1LRP19">#forum-app-design-system on NHS England Slack</a></li>
<li><a href="https://nhs-service-manual.slack.com/archives/CDJ29AQCD">#general on NHS service manual Slack</a></li>
</ul>
<p>You can also <a href="/help-and-feedback/">share feedback with us on Slack</a>.</p>
26 changes: 26 additions & 0 deletions docs/_includes/layouts/plain.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{% extends "./base.njk" %}

{% block breadcrumb %}
{{ breadcrumb({
href: "/",
text: "Home"
}) }}
{% endblock %}

{% block container %}
<div class="nhsuk-width-container">
<div class="nhsuk-grid-row">
<div class="nhsuk-grid-column-two-thirds">
<main role="main" id="maincontent" class="nhsuk-main-wrapper app-content">
{% block main %}
<h1 class="nhsuk-heading-xl nhsuk-u-margin-bottom-5">
{{ title }}
</h1>
<p class="nhsuk-body-l nhsuk-u-margin-bottom-7">{{ description }}</p>
{{ content | safe }}
{% endblock %}
</main>
</div>
</div>
</div>
{% endblock %}
Loading