Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 331587b

Browse files
ovflowdmikeesto
andauthored
chore(pr-template): add check list (#2574)
Co-authored-by: Michael Esteban <mickel13@gmail.com>
1 parent ab7c789 commit 331587b

File tree

8 files changed

+126
-63
lines changed

8 files changed

+126
-63
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: 🐛 Bug Report For Nodejs Dev Website
2+
description: Report an issue if something isn't working as expected 🤔.
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for wanting to report an issue you've found on the nodejs.dev website.
9+
Please fill in the template below. If unsure about something, just do as best
10+
as you're able. If you are reporting a visual glitch, it will be much easier
11+
for us to fix it when you attach a screenshot as well.
12+
- type: input
13+
attributes:
14+
label: "URL:"
15+
description: The URL of the page you are reporting an issue on.
16+
placeholder: https://nodejs.dev
17+
validations:
18+
required: true
19+
- type: input
20+
attributes:
21+
label: "Browser Name:"
22+
description: What kind of browser are you using?
23+
placeholder: Chrome
24+
validations:
25+
required: true
26+
- type: input
27+
attributes:
28+
label: "Browser Version:"
29+
description: What version of browser are you using?
30+
placeholder: "103.0.5060.134"
31+
validations:
32+
required: true
33+
- type: input
34+
attributes:
35+
label: "Operating System:"
36+
description:
37+
What operating system are you using
38+
(Write it in full, with version number)?
39+
placeholder: "Windows 10, 21H2, 19044.1826"
40+
validations:
41+
required: true
42+
- type: textarea
43+
attributes:
44+
label: "How to reproduce the issue:"
45+
placeholder: |
46+
1. What I did.
47+
2. What I expected to happen.
48+
3. What I actually got.
49+
4. If possible, images or videos are welcome.
50+
validations:
51+
required: true

.github/ISSUE_TEMPLATE/bug_report.md

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

.github/ISSUE_TEMPLATE/docs.md

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

.github/ISSUE_TEMPLATE/docs.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: 📖 Documentation Improvement
2+
description: Use this template for making changes in the docs.
3+
labels: [docs]
4+
body:
5+
- type: dropdown
6+
attributes:
7+
label: "The Documentation is?"
8+
description: What is currently wrong with the docs?
9+
options:
10+
- Missing
11+
- Incorrect
12+
- Confusing
13+
- Not sure?
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: "Please Explain in details:"
19+
placeholder: |
20+
1. What part of the docs affect your report?
21+
2. What do you propose to be changed?
22+
3. Pleae include any relevant URLs
23+
validations:
24+
required: true
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: 🚀 Feature Request For Nodejs Website
2+
description: I have a suggestion (and may want to implement it)!
3+
labels: [enhancement]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
You have an idea how to improve the site? That's awesome!
9+
Before submitting, please have a look at the existing issues if there's already
10+
something related to your suggestion.
11+
- type: textarea
12+
attributes:
13+
label: "Enter your suggestions in details:"
14+
placeholder: |
15+
1. What I expected to happen.
16+
2. Your reason (if possible, images or videos are welcome).
17+
3. What I plan to do (Optional but better).
18+
validations:
19+
required: true

.github/ISSUE_TEMPLATE/feature_request.md

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

.github/ISSUE_TEMPLATE/i18n.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: 🔡 Internationalization and translations For Nodejs Website
2+
description: Hello. Hola. Salut. Ciao. Здравствуйте. こんにちは.
3+
labels: [i18n]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please mention the relevant localization team in your issue,
9+
it helps us having the right people take a look, or if you want
10+
to create a new localization team.
11+
- type: textarea
12+
attributes:
13+
label: "Enter your issue on localizations here:"
14+
placeholder: |
15+
1. The name of the team (e.g: nodejs/node-cn).
16+
2. Any problems to report or you want to create it?
17+
validations:
18+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22
Please read the [Code of Conduct](https://github.com/nodejs/nodejs.dev/blob/main/CODE_OF_CONDUCT.md) and the [Contributing Guidelines](https://github.com/nodejs/nodejs.dev/blob/main/CONTRIBUTING.md) before opening a pull request.
33
-->
44

5+
### Check List
6+
7+
<!--
8+
ATTENTION
9+
Please follow this check list to ensure that you've followed all items before opening this PR
10+
-->
11+
12+
- [ ] I have read the [Contributing Guidelines](https://github.com/nodejs/nodejs.dev/blob/main/CONTRIBUTING.md) and made commit messages that follow the guideline.
13+
- [ ] I have run `npm run lint:js -- --fix` and/or `npm run lint:md -- --fix` for my JavaScript and/or Markdown changes.
14+
- This is important as most of the cases your code changes might not be correctly linted
15+
- [ ] I have run `npm run test` to check if all tests are passing, and/or `npm run test -- -u` to update snapshots if I created and/or updated React Components.
16+
- [ ] I have checked that the build works locally and that `npm run build` and `npm run build-storybook` work fine.
17+
- [ ] I've covered new added functionality with unit tests if necessary.
18+
519
## Description
620

721
<!-- Write a brief description of the changes introduced by this PR -->

0 commit comments

Comments
 (0)