diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..d1b221bc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,42 @@ +--- +name: Bug report +about: Describe the issue so we may fix it +title: '' +labels: bug +assignees: '' + +--- + +## Version + +``` +Describe the version of Dn-FamiTracker you are using, as well as details about +your operating system. + +If you are using a non-Windows OS, please describe the program used to run +Dn-FamiTracker. +``` + +- Dn-FamiTracker version: + - 0.5.2 +- OS: + - Windows 10 Version 10.0.19045 Build 19045 + +## Description + +``` +Please describe the issue. +``` + +## Steps to reproduce + +1. Provide instructions in step-by-step order. +2. Be as concise as possible. + - Bullet points may be added to note some things about the step. +3. A good example: #382 + +## Attachments + +``` +insert screenshots, videos, or example modules to illustrate your issue +``` diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..35686dad --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,34 @@ +``` +Pull request format: + +This pull request aims to `<(specify reason)>`. + +--- + +Changes: + +- `` + - Fixes/addresses issue `#`. + +Changelog format: + - Categories + - `Important changes:` + - summary of immediate and obvious changes to the program + - `Improvements:` + - additions and refactoring + - `Bug fixes:` + - any bug fixes + - `Internal:` + - meta changes, including changes regarding to the repository or CI + - Format + - ` ([issue_author] [commit_author] [#] [#])` + - only put in issue author and number if it exists + - only put one author if issue and commit author is the same + - sort by category, then by issue number, then by PR number + - ex: + - `Fix access violation in MRU submenu list update (@eugene-s-nesdev @Gumball2415 #243 #214)` + +Notice: +- Please remove this code block and fill in the details. +- Be sure to update CHANGELOG.md in the `Unreleased` section, as well as the date last updated. +``` diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 9f615a2d..f3e68e68 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -6,11 +6,11 @@ Written by D.P.C.M. Version 0.5.2.9 -Last updated: December 22, 2025 +Last updated: December 25, 2025 --- -## Unreleased - 2025-12-22 +## Unreleased - 2025-12-25 - ### Important changes: @@ -30,6 +30,9 @@ Last updated: December 22, 2025 - Indicate build type in packaging script (@Gumball2415 #365 #389) - Use only three version numbers for welcome message (@Gumball2415 #365 #389) - Update documentation regarding version updating (@Gumball2415 #389) + - Add issue templates (@Gumball2415 #395) + - Clarify the template nature of the PR template (@Gumball2415 #395) + - Include change log format in PR template (@Gumball2415 #395) ## Dn0.5.2 - 2025-08-18 diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md deleted file mode 100644 index 0f5a2e0d..00000000 --- a/docs/pull_request_template.md +++ /dev/null @@ -1,8 +0,0 @@ -This pull request aims to `(specify reason)`. - -(If applicable) This pull request improves upon and supercedes `#`. - -### Changes in this PR: - -- (cite all changes made in the PR for change log) - - Fixes/addresses issue `#`. diff --git a/docs/version_update.md b/docs/version_update.md index 3f401368..6695748c 100644 --- a/docs/version_update.md +++ b/docs/version_update.md @@ -2,23 +2,22 @@ - [ ] Update changelogs: - [CHANGELOG.md](CHANGELOG.md), which will update [../Dn-Help/hlp/changelog_shell.htm](changelog_shell.htm) upon build - - Format for changelog: - - categories - - `Important changes:` - - summary of immediate and obvious changes to the program - - `Improvements:` - - additions and refactoring - - `Bug fixes:` - - any bug fixes - - `Internal:` - - meta changes, including changes regarding to the repository or CI - - format - - ` ([issue_author] [commit_author] [#] [#])` - - only put in issue author and number if it exists - - only put one author if issue and commit author is the same - - sort by category, then by issue number, then by PR number - - ex: - - `Fix access violation in MRU submenu list update (@eugene-s-nesdev @Gumball2415 #243 #214)` + - Categories + - `Important changes:` + - summary of immediate and obvious changes to the program + - `Improvements:` + - additions and refactoring + - `Bug fixes:` + - any bug fixes + - `Internal:` + - meta changes, including changes regarding to the repository or CI + - Format + - ` ([issue_author] [commit_author] [#] [#])` + - only put in issue author and number if it exists + - only put one author if issue and commit author is the same + - sort by category, then by issue number, then by PR number + - ex: + - `Fix access violation in MRU submenu list update (@eugene-s-nesdev @Gumball2415 #243 #214)` - [ ] Create Version Tag - Format: `Dnx.y.z.b` - x: Major (API change)