Skip to content

Commit 739e284

Browse files
authored
GitHub issue and pull request templates (#395)
This pull request aims to add an issue template and clarify the pull request template. --- Changes: - Add issue templates - Clarify the template nature of the PR template - Include change log format in PR template
2 parents bddca1a + b6e6906 commit 739e284

File tree

5 files changed

+97
-27
lines changed

5 files changed

+97
-27
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Bug report
3+
about: Describe the issue so we may fix it
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
## Version
11+
12+
```
13+
Describe the version of Dn-FamiTracker you are using, as well as details about
14+
your operating system.
15+
16+
If you are using a non-Windows OS, please describe the program used to run
17+
Dn-FamiTracker.
18+
```
19+
20+
- Dn-FamiTracker version:
21+
- 0.5.2
22+
- OS:
23+
- Windows 10 Version 10.0.19045 Build 19045
24+
25+
## Description
26+
27+
```
28+
Please describe the issue.
29+
```
30+
31+
## Steps to reproduce
32+
33+
1. Provide instructions in step-by-step order.
34+
2. Be as concise as possible.
35+
- Bullet points may be added to note some things about the step.
36+
3. A good example: #382
37+
38+
## Attachments
39+
40+
```
41+
insert screenshots, videos, or example modules to illustrate your issue
42+
```

.github/pull_request_template.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
```
2+
Pull request format:
3+
4+
This pull request aims to `<(specify reason)>`.
5+
6+
---
7+
8+
Changes:
9+
10+
- `<Describe change entry>`
11+
- Fixes/addresses issue `#<issue number>`.
12+
13+
Changelog format:
14+
- Categories
15+
- `Important changes:`
16+
- summary of immediate and obvious changes to the program
17+
- `Improvements:`
18+
- additions and refactoring
19+
- `Bug fixes:`
20+
- any bug fixes
21+
- `Internal:`
22+
- meta changes, including changes regarding to the repository or CI
23+
- Format
24+
- `<description of singular change> ([issue_author] [commit_author] [#<issue number>] [#<PR number>])`
25+
- only put in issue author and number if it exists
26+
- only put one author if issue and commit author is the same
27+
- sort by category, then by issue number, then by PR number
28+
- ex:
29+
- `Fix access violation in MRU submenu list update (@eugene-s-nesdev @Gumball2415 #243 #214)`
30+
31+
Notice:
32+
- Please remove this code block and fill in the details.
33+
- Be sure to update CHANGELOG.md in the `Unreleased` section, as well as the date last updated.
34+
```

docs/CHANGELOG.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ Written by D.P.C.M.
66

77
Version 0.5.2.9
88

9-
Last updated: December 22, 2025
9+
Last updated: December 25, 2025
1010

1111
---
1212

13-
## Unreleased - 2025-12-22
13+
## Unreleased - 2025-12-25
1414

1515
- ### Important changes:
1616

@@ -30,6 +30,9 @@ Last updated: December 22, 2025
3030
- Indicate build type in packaging script (@Gumball2415 #365 #389)
3131
- Use only three version numbers for welcome message (@Gumball2415 #365 #389)
3232
- Update documentation regarding version updating (@Gumball2415 #389)
33+
- Add issue templates (@Gumball2415 #395)
34+
- Clarify the template nature of the PR template (@Gumball2415 #395)
35+
- Include change log format in PR template (@Gumball2415 #395)
3336

3437
## Dn0.5.2 - 2025-08-18
3538

docs/pull_request_template.md

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

docs/version_update.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,22 @@
22

33
- [ ] Update changelogs:
44
- [CHANGELOG.md](CHANGELOG.md), which will update [../Dn-Help/hlp/changelog_shell.htm](changelog_shell.htm) upon build
5-
- Format for changelog:
6-
- categories
7-
- `Important changes:`
8-
- summary of immediate and obvious changes to the program
9-
- `Improvements:`
10-
- additions and refactoring
11-
- `Bug fixes:`
12-
- any bug fixes
13-
- `Internal:`
14-
- meta changes, including changes regarding to the repository or CI
15-
- format
16-
- `<description of singular change> ([issue_author] [commit_author] [#<issue number>] [#<PR number>])`
17-
- only put in issue author and number if it exists
18-
- only put one author if issue and commit author is the same
19-
- sort by category, then by issue number, then by PR number
20-
- ex:
21-
- `Fix access violation in MRU submenu list update (@eugene-s-nesdev @Gumball2415 #243 #214)`
5+
- Categories
6+
- `Important changes:`
7+
- summary of immediate and obvious changes to the program
8+
- `Improvements:`
9+
- additions and refactoring
10+
- `Bug fixes:`
11+
- any bug fixes
12+
- `Internal:`
13+
- meta changes, including changes regarding to the repository or CI
14+
- Format
15+
- `<description of singular change> ([issue_author] [commit_author] [#<issue number>] [#<PR number>])`
16+
- only put in issue author and number if it exists
17+
- only put one author if issue and commit author is the same
18+
- sort by category, then by issue number, then by PR number
19+
- ex:
20+
- `Fix access violation in MRU submenu list update (@eugene-s-nesdev @Gumball2415 #243 #214)`
2221
- [ ] Create Version Tag
2322
- Format: `Dnx.y.z.b`
2423
- x: Major (API change)

0 commit comments

Comments
 (0)