mirror of
https://github.com/tribufu/node-gamedig
synced 2026-05-06 07:07:33 +00:00
meta: add pr templates (#698)
* meta: add pull request templates * add a checklist for the changelog file * make it clear that you dont have to mention yourself ... in the changelog file * fix list * change label on feature template * add better context section
This commit is contained in:
parent
a3fca5d590
commit
6a3cbece69
2 changed files with 68 additions and 0 deletions
34
.github/PULL_REQUEST_TEMPLATE/feature.md
vendored
Normal file
34
.github/PULL_REQUEST_TEMPLATE/feature.md
vendored
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
name: Feature
|
||||
about: Add something new and hopefully useful
|
||||
title: 'feat: add this game'
|
||||
labels: feature
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!-- This section must be completed! -->
|
||||
**Describe the changes**
|
||||
- [ ] I have added a line in the [CHANGELOG.md](https://github.com/gamedig/node-gamedig/blob/master/CHANGELOG.md) file.
|
||||
<!-- (example): `* Feat: Add a 10th character (By @you, #PR_NUMBER)` -->
|
||||
<!-- Note: mentioning yourself is not necessary, everything else is! -->
|
||||
|
||||
A clear and concise summary of the changes.
|
||||
|
||||
**Screenshots or Data**
|
||||
If applicable, add screenshots/data to help explain the changes.
|
||||
<details>
|
||||
This contains lots and lots of logs.
|
||||
```
|
||||
How to do a collapsible section:
|
||||
<details>
|
||||
This is hidden until it is not!
|
||||
</details>
|
||||
```
|
||||
</details>
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the changes here, for example:
|
||||
* 'Closes issue #T, lore-related to issue #F, mentioned in pr #Two'
|
||||
* 'To validate the changes, one can test on this address: 127.255.0.256'
|
||||
* 'I couldn't find any live servers to validate these changes, here are the docs on how to start a local server: www.google.com'
|
||||
34
.github/PULL_REQUEST_TEMPLATE/fix.md
vendored
Normal file
34
.github/PULL_REQUEST_TEMPLATE/fix.md
vendored
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
name: Fix
|
||||
about: Change something broken to make it not broken anymore
|
||||
title: 'fix: 1 === 1 is false'
|
||||
labels: bug
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!-- This section must be completed! -->
|
||||
**Describe the changes**
|
||||
- [ ] I have added a line in the [CHANGELOG.md](https://github.com/gamedig/node-gamedig/blob/master/CHANGELOG.md) file.
|
||||
<!-- (example): `* Fix: The word engineer has 3 e's in it (By @you, #PR_NUMBER)` -->
|
||||
<!-- Note: mentioning yourself is not necessary, everything else is! -->
|
||||
|
||||
A clear and concise summary of the changes.
|
||||
|
||||
**Screenshots or Data**
|
||||
If applicable, add screenshots/data to help explain the changes.
|
||||
<details>
|
||||
This contains lots and lots of logs.
|
||||
```
|
||||
How to do a collapsible section:
|
||||
<details>
|
||||
This is hidden until it is not!
|
||||
</details>
|
||||
```
|
||||
</details>
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the changes here, for example:
|
||||
* 'Closes issue #T, lore-related to issue #F, mentioned in pr #Two'
|
||||
* 'To validate the changes, one can test on this address: 127.255.0.256'
|
||||
* 'I couldn't find any live servers to validate these changes, here are the docs on how to start a local server: www.google.com'
|
||||
Loading…
Add table
Add a link
Reference in a new issue