Skip to content

Commit 4628e36

Browse files
committed
update issue templates
1 parent 6157c31 commit 4628e36

File tree

5 files changed

+62
-68
lines changed

5 files changed

+62
-68
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 18 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -3,50 +3,33 @@ description: Report a bug
33
labels: [bug]
44
assignees: []
55
body:
6-
- type: checkboxes
7-
id: checks
6+
- type: markdown
87
attributes:
9-
label: Prerequisites
10-
description: |
11-
*If **all** checks are not passed then the issue will be closed.*
12-
options:
13-
- label: I have checked that no other similar issue already exists.
14-
required: true
15-
- label: I have checked that this issue is actually a bug and not a feature.
16-
required: true
17-
- label: I am running the latest release version.
18-
required: true
8+
value: |
9+
Before opening a bug report please check that your issue was not already discussed in the following:
10+
11+
* [Issues](https://github.com/Katsute/GitHub-Red-Issues/issues?q=is%3Aissue+is%3Aopen+label%3Abug%2C%22critical+bug%22)
12+
13+
Please also check that:
14+
15+
* This is actually a bug and not a feature.
16+
* You are running the latest version.
1917
2018
- type: input
21-
id: os
2219
attributes:
2320
label: Operating System
24-
description: |
25-
Operating system name and version.
26-
placeholder: |
27-
ex: Windows 10
2821
validations:
2922
required: true
3023

3124
- type: input
32-
id: browser
3325
attributes:
3426
label: Browser
35-
description: |
36-
Browser name and version if possible.
37-
placeholder: |
38-
ex: Google Chrome, Google Chrome 96
3927
validations:
4028
required: true
4129

4230
- type: input
43-
id: version
4431
attributes:
4532
label: Extension Version
46-
description: |
47-
Release version or branch commit where the issue occured. Do not write 'latest'.
48-
placeholder: |
49-
ex: v2, 8266f8b
5033
validations:
5134
required: true
5235

@@ -87,10 +70,15 @@ body:
8770
required: false
8871

8972
- type: textarea
90-
id: issue
9173
attributes:
9274
label: Issue
75+
validations:
76+
required: true
77+
78+
- type: textarea
79+
attributes:
80+
label: How to replicate
9381
description: |
94-
Explain your issue.
82+
Include steps to reproduce this issue.
9583
validations:
96-
required: false
84+
required: true

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,18 @@ description: Suggest a new feature
33
labels: [enhancement]
44
assignees: []
55
body:
6-
- type: checkboxes
7-
id: checks
6+
- type: markdown
87
attributes:
9-
label: Prerequisites
10-
description: |
11-
*If **all** checks are not passed then the issue will be closed.*
12-
options:
13-
- label: I have checked that no other similar feature request already exists.
14-
required: true
15-
- label: This feature request makes sense for the project.
16-
required: true
17-
- label: I have checked that this feature does not already exist.
18-
required: true
19-
- label: I am running the latest release version.
20-
required: true
8+
value: |
9+
Before opening a feature request please check that your idea was not already discussed in the following:
10+
11+
* [Issues](https://github.com/Katsute/GitHub-Red-Issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22feature+request%22)
12+
13+
Please also check that:
14+
15+
* This feature makes sense for the project.
16+
* This feature does not already exist.
17+
* You are running the latest version.
2118
2219
- type: textarea
2320
id: feature

.github/pull_request_template.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
### Prerequisites
2-
*If checks are not passed then the pull request will be closed.*
2+
*Issues must meet the following criteria:*
33

4-
- [ ] I have checked that no other similar pull request already exists.
5-
- [ ] My code follows the general code style as the rest of the code.
4+
- [ ] No similar [pull request](https://github.com/Katsute/GitHub-Red-Issues/pulls) exists.
5+
- [ ] Code follows the general code style of this project.
6+
- [ ] No sensitive information is exposed.
7+
- [ ] Relevant comments have been added.
8+
9+
### GitHub Copilot Disclaimer
10+
*The use of GitHub Copilot is **strictly prohibited** on this repository.*
11+
12+
- [ ] This pull does not use GitHub Copilot.
613

714
### Changes Made
815
*List any changes made and/or other relevant issues.*
916

10-
-
17+
-

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -24,45 +24,45 @@
2424
</div>
2525
</div>
2626

27-
## Installation
27+
## 📃 Installation
2828

29-
#### Chrome
29+
#### Chrome (recommended)
3030

3131
<a href="https://chrome.google.com/webstore/detail/github-red-issues/kjbbjibfgnnfdeabgmbieapkhpojikpc"><img src="https://raw.githubusercontent.com/Katsute/GitHub-Red-Issues/main/assets/chrome.svg" width="48" alt="Google Chrome"></a>
3232
<a href="https://chrome.google.com/webstore/detail/github-red-issues/kjbbjibfgnnfdeabgmbieapkhpojikpc"><img src="https://raw.githubusercontent.com/Katsute/GitHub-Red-Issues/main/assets/edge.svg" width="48" alt="Microsoft Edge"></a>
3333
<a href="https://chrome.google.com/webstore/detail/github-red-issues/kjbbjibfgnnfdeabgmbieapkhpojikpc"><img src="https://raw.githubusercontent.com/Katsute/GitHub-Red-Issues/main/assets/opera.svg" width="48" alt="Opera"></a>
3434
[![Chrome Web Store](https://img.shields.io/chrome-web-store/v/kjbbjibfgnnfdeabgmbieapkhpojikpc?label=%20&style=flat-square)](https://chrome.google.com/webstore/detail/github-red-issues/kjbbjibfgnnfdeabgmbieapkhpojikpc)
3535

36-
#### Firefox
36+
#### Firefox (recommended)
3737

3838
<a href="https://addons.mozilla.org/firefox/addon/github-red-issues"><img src="https://raw.githubusercontent.com/Katsute/GitHub-Red-Issues/main/assets/firefox.svg" width="48" alt="Mozilla Firefox"></a>
3939
[![Mozilla Add-on](https://img.shields.io/amo/v/github-red-issues?label=%20&style=flat-square)](https://addons.mozilla.org/firefox/addon/github-red-issues)
4040

4141
#### Checkout
4242

43-
1. Checkout or download this repository locally.
44-
2. Go to [`chrome://extensions/`](chrome://extensions/) in your browser and turn on **Developer mode** in the top right.
45-
3. Press **Load unpacked** and select the `src` folder. Do not remove this folder, removing it will cause the extension to be uninstalled.
46-
4. Resume coding with closed issues being red.
43+
1. Checkout or download this repository locally.
44+
2. Go to [`chrome://extensions/`](chrome://extensions/) in your browser and turn on **Developer mode** in the top right.
45+
3. Press **Load unpacked** and select the `src` folder. Do not remove this folder, removing it will cause the extension to be uninstalled.
46+
4. Resume coding with closed issues being red.
4747

48-
## Changes
48+
## Changes
4949

5050
Reverted closed issues from purple to red on:
5151

52-
- Pinned issues
53-
- Issue hover cards
54-
- Issue/pull timelines
55-
- Issues on issues tab
56-
- Issues on subscriptions list
57-
- Issues on search
58-
- Issues on projects
59-
- Issues on projects (beta)
52+
- Pinned issues
53+
- Issue hover cards
54+
- Issue/pull timelines
55+
- Issues on issues tab
56+
- Issues on subscriptions list
57+
- Issues on search
58+
- Issues on projects
59+
- Issues on projects (beta)
6060

61-
## Contributing
61+
## 👨‍💻 Contributing
6262

63-
- Found a bug? Open a new [issue](https://github.com/Katsute/GitHub-Red-Issues/issues).
64-
- Want to contribute? Create a [fork](https://github.com/Katsute/GitHub-Red-Issues/fork) and open a [pull request](https://github.com/Katsute/GitHub-Red-Issues/pulls).
63+
- Found a bug? Open a new [issue](https://github.com/Katsute/GitHub-Red-Issues/issues).
64+
- Want to contribute? Create a [fork](https://github.com/Katsute/GitHub-Red-Issues/fork) and open a [pull request](https://github.com/Katsute/GitHub-Red-Issues/pulls).
6565

66-
## License
66+
### 💼 License
6767

6868
This extension is released under the [CC-BY-NC-SA 4.0 License](https://github.com/Katsute/GitHub-Red-Issues/blob/main/LICENSE).

build.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
// Copyright (C) 2022 Katsute <https://github.com/Katsute>
2+
13
import fs from "fs";
24
import path from "path";
35

0 commit comments

Comments
 (0)