Skip to content

Commit 68f3428

Browse files
jackdomleo7jackdomleo7
committed
Edited issue & PR templates
1 parent 4d67d79 commit 68f3428

9 files changed

Lines changed: 296 additions & 89 deletions

File tree

‎.github/ISSUE_TEMPLATE/a11y-feature-request.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: ♿ A11y feature request
3+
about: Suggest an idea for a new a11y feature
4+
title: '[A11Y FEATURE]: <title>'
5+
labels: a11y-feature
6+
7+
---
8+
9+
<!--
10+
🧡 Thank you for your time to make Checka11y.css better with your feedback.
11+
12+
A properly researched a11y feature request can help save a lot of time during development.
13+
-->
14+
15+
# A11y Feature Request
16+
17+
## Describe the new a11y feature
18+
<!--
19+
A clear and concise description of what the a11y feature is.
20+
Back up your point with trusted links.
21+
Provide screenshots if necessary.
22+
-->
23+
24+
## Acceptance criteria
25+
<!--
26+
Provide a bullet-pointed list of acceptance criteria.
27+
-->
28+
-
29+
-
30+
31+
32+
## Why is this a11y feature important?
33+
<!--
34+
Explain how implementing this feature will help developers.
35+
This helps us decide the priority order of issues.
36+
-->

‎.github/ISSUE_TEMPLATE/bug-report.md‎

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,44 @@
11
---
22
name: 🐞 Bug report
3-
about: Report a bug report to help us improve Checka11y.css.
4-
title: ''
5-
labels: 'bug'
6-
assignees: ''
3+
about: File a bug report to help us improve Checka11y.css
4+
labels: bug
5+
title: '[BUG]: <title>'
76

87
---
98

10-
<!-- 🧡 Thanks for your time to make Checka11y.css better with your feedbacks 🧡
9+
<!--
10+
🧡 Thank you for your time to make Checka11y.css better with your feedback.
1111
12-
👍 A properly detailed bug report can save a LOT of time and help fixing issues as soon as possible.
12+
👍 A properly detailed bug report can save a lot of time and help to fix issues as soon as possible.
1313
14-
A bug could be:
15-
- An incorrectly implemented a11y check
16-
- Syntax error
17-
- Wrong CSS used
18-
- Other (if you think you've found a different type of bug, please still raise it and we will review)
14+
A bug could be:
15+
- An incorrectly implemented a11y feature
16+
- Syntax error
17+
- Wrong CSS used
18+
- Other (if you think you've found a different type of bug, please still raise it and we will review)
1919
-->
20+
# Bug Report
2021

21-
### Details
22-
23-
<!-- Provide as much detail as you can with links that backup why this is a bug, why it's wrong and how we could fix it -->
24-
<!-- If the bug is to do with browser and/or device, please provide details:
25-
- Browser and version
26-
- Operating system
27-
-->
22+
## Details of the bug
23+
<!--
24+
Provide as much detail as you can about this bug.
25+
Provide screenshots if applicable.
26+
-->
27+
Checka11y.css version:
2828

29-
### Screenshot(s)
29+
## What is the expected result?
3030

31-
<!-- Add screenshots if applicable -->
3231

33-
### What is Expected?
32+
## What is the actual result?
3433

34+
## Acceptance criteria
35+
<!--
36+
Provide a bullet-pointed list of acceptance criteria.
37+
-->
38+
-
39+
-
3540

36-
### What is actually happening?
41+
## Why is fixing this bug important?
42+
<!--
43+
This helps us decide the priority order of issues.
44+
-->

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: 📰 Documentation issue or feature
3+
about: Suggest an idea or identify an issue for the documentation
4+
title: '[DOCUMENTATION]: <title>'
5+
labels: documentation
6+
7+
---
8+
9+
<!--
10+
🧡 Thank you for your time to make Checka11y.css better with your feedback.
11+
-->
12+
13+
# Documentation Issue or Feature
14+
15+
## Describe the documentation issue or feature request
16+
<!--
17+
A clear and concise description.
18+
Provide screenshots if necessary.
19+
-->
20+
21+
## Acceptance criteria
22+
<!--
23+
Provide a bullet-pointed list of acceptance criteria.
24+
-->
25+
-
26+
-
27+
28+
29+
## Why is this important?
30+
<!--
31+
This helps us decide the priority order of issues.
32+
-->

‎.github/ISSUE_TEMPLATE/feature-request.md‎

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/project-enhancement-idea.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: 💻 Project enhancement/maintenance idea
3+
about: Suggest an idea for a project enhancement or maintenance
4+
title: '[ENHANCEMENT]: <title>'
5+
labels: project-enhancement
6+
7+
---
8+
9+
<!--
10+
🧡 Thank you for your time to make Checka11y.css better with your feedback.
11+
-->
12+
13+
# Project Enhancement or Maintenance Idea
14+
15+
## Describe the enhancement or maintenance
16+
<!--
17+
A clear and concise description of what the enhancement or maintenance is.
18+
Back up your point with trusted links if you can.
19+
Provide screenshots if necessary.
20+
-->
21+
22+
## Acceptance criteria
23+
<!--
24+
Provide a bullet-pointed list of acceptance criteria.
25+
-->
26+
-
27+
-
28+
29+
30+
## Why is this enhancement or maintenance important?
31+
<!--
32+
This helps us decide the priority order of issues.
33+
-->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 0 additions & 42 deletions
This file was deleted.

‎.github/PULL_REQUEST_TEMPLATE/a11y-feature.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
name: ♿ A11y feature
3+
about: Submit a new a11y feature
4+
labels: a11y-feature
5+
title: '[A11Y FEATURE]: <title>'
6+
---
7+
8+
## A11y feature description
9+
<!--
10+
Clearly and concisely describe the new a11y feature.
11+
Link to an existing issue if one exists.
12+
Provide screenshots.
13+
-->
14+
15+
## Why is this feature important?
16+
<!--
17+
Explain why this feature is important to have in Checka11y.css.
18+
Provide any relevant links to back up your reasoning.
19+
If this pull request resolves an `a11y-feature` issue, you can leave this section out and just put "This is described in the linked issue."
20+
-->
21+
22+
## Covered test cases
23+
<!--
24+
Were any tests added or modified for this feature?
25+
-->
26+
27+
### Did you test on all major browsers?
28+
<!--
29+
Put an `x` in all the boxes that apply.
30+
If not, please add a brief explanation as to why you couldn't (e.g. "I couldn't test Safari because I don't have access to an Apple device).
31+
-->
32+
- [ ] Chrome
33+
- [ ] Firefox
34+
- [ ] Edge
35+
- [ ] Safari
36+
37+
## Other details
38+
<!--
39+
Please add any other details we should be aware of below that don't fit in any of the categories above (e.g. "I would like this pull request to contribute towards my Hacktoberfest contributions").
40+
If you have nothing to add here, put "N/A".
41+
-->
42+
43+
---
44+
45+
## T&Cs
46+
<!--
47+
Put an `x` in all the boxes that you agree to.
48+
-->
49+
50+
- [ ] I confirm I have read and understand the [contributing guidelines](../../CONTRIBUTING.md)
51+
- [ ] I understand the work in this pull request will not be released straight away and will appear in a future release (if approved)
52+
- [ ] I confirm the work in this pull request is true and valid to the best of my knowledge
53+
- [ ] I have updated the [README](../../README.md), [features.md](../../features.md) and [codes.md](../../codes.md) files where applicable

‎.github/PULL_REQUEST_TEMPLATE/bug-fix.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: 🐞 Bug fix
3+
about: Submit a bug fix
4+
labels: bug
5+
title: '[BUG FIX]: <title>'
6+
---
7+
8+
## Bug description
9+
<!--
10+
Clearly and concisely describe the problem.
11+
Link to an existing issue if one exists.
12+
Provide any screenshots if applicable.
13+
-->
14+
15+
## Root cause
16+
<!--
17+
Briefly describe the root cause and analysis of the problem.
18+
-->
19+
20+
## Solution description
21+
<!--
22+
Describe your investigation and your code changes in detail.
23+
Explain the technical solution you have provided and how it fixes the issue case.
24+
Provide any screenshots if applicable.
25+
-->
26+
27+
## Covered test cases
28+
<!--
29+
Were any tests added or modified for this fix, or was only manual testing applicable?
30+
Can we add a test to prevent this bug from happening in the future (if applicable)?
31+
-->
32+
33+
### Did you test on all major browsers?
34+
<!--
35+
Put an `x` in all the boxes that apply.
36+
If not, please add a brief explanation as to why you couldn't (e.g. "I couldn't test Safari because I don't have access to an Apple device).
37+
-->
38+
- [ ] Chrome
39+
- [ ] Firefox
40+
- [ ] Edge
41+
- [ ] Safari
42+
43+
## Other details
44+
<!--
45+
Please add any other details we should be aware of below that don't fit in any of the categories above (e.g. "I would like this pull request to contribute towards my Hacktoberfest contributions").
46+
If you have nothing to add here, put "N/A".
47+
-->
48+
49+
---
50+
51+
## T&Cs
52+
<!--
53+
Put an `x` in all the boxes that you agree to.
54+
-->
55+
56+
- [ ] I confirm I have read and understand the [contributing guidelines](../../CONTRIBUTING.md)
57+
- [ ] I understand the work in this pull request will not be released straight away and will appear in a future release (if approved)
58+
- [ ] I confirm the work in this pull request is true and valid to the best of my knowledge
59+
- [ ] I have updated the [README](../../README.md), [features.md](../../features.md) and [codes.md](../../codes.md) files where applicable

0 commit comments

Comments
 (0)