Skip to content

Commit c8f2cda

Browse files
committed
Update contributing and PR template
1 parent 0393bdd commit c8f2cda

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

docs/CONTRIBUTING.md

+12-7
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,17 @@ Welcome! Thank you for considering to contribute to Dn-FamiTracker. We really ne
1212

1313
## Git guidelines
1414

15-
- Write pull requests that passes CI builds.
16-
- Make sure to adhere to the [pull request template](pull_request_template.md) message guidelines.
15+
- Write pull requests that passes CI builds and tests.
16+
- Make sure to adhere to the [pull request template](Dn-FamiTracker/docs/pull_request_template.md) message guidelines.
1717
- Base your pull request on the `main` branch.
18-
- If a merge conflict happens due to not being updated in a long time, resolve merge conflicts and rebase your pull request to the latest reasonable version of the `main` branch.
18+
- If a merge conflict happens due to not being updated in a long time, resolve merge conflicts and rebase your pull request to the latest compatible version of the `main` branch.
19+
- Be sure to update [Dn-Help](https://github.com/Dn-Programming-Core-Management/Dn-help) on your pull request as needed.
20+
- Create a corresponding pull request on Dn-help that links to your main pull request.
1921

2022
### For Dn-FT maintainers:
2123

22-
- Do **NOT** push directly to the `main` branch. Instead, push your changes to these branches first before writing a pull request:
24+
- Do **NOT** push directly to the `main` branch. Instead, push your changes to a branch first before writing a pull request.
25+
- These branches are designated to be reoccurring may be used for the following:
2326
- `app-emu-module-nsf_driver-dev`
2427
- This branch is for modifying the application itself, such as the NSF driver, the module format, loading and saving code, emulator core, audio drivers, etc.
2528
- `docs-license-ver-meta-dev`
@@ -29,7 +32,7 @@ Welcome! Thank you for considering to contribute to Dn-FamiTracker. We really ne
2932
- You will most likely force push this branch to hell and back, so be sure to do it on your own GitHub user's fork.
3033
- Other branches may be made for more niche/specific modifications and fixes.
3134
- If your pull request touches two or more of these categories, it's fine but please keep it minimal.
32-
- Otherwise, create a new branch as mentioned previously.
35+
- Otherwise, create a new branch.
3336

3437
## Dependencies and Building
3538

@@ -64,5 +67,7 @@ To edit and/or build the source, you may use Visual Studio 2022, or alternativel
6467

6568
## Important Things to Note
6669

67-
- When committing changes, **file extension case must be the same as the original file!** This might result in merge conflicts, because Git is case sensitive, but in Windows systems, the file system is case insensitive by default.
68-
- Additionally, case sensitivity in Windows can be enabled through WSL, but it **must only be enabled to resolve merge conflicts regarding file extension case sensitivity**. If case sensitivity is left enabled, Visual Studio throws a bunch of errors due to the way IntelliSense capitalizes paths internally.
70+
- When committing changes, ***file extension case must be the same as the original file!***
71+
- This might result in merge conflicts, because Git is case sensitive, but in Windows systems, the file system is case insensitive by default.
72+
- Additionally, case sensitivity in Windows can be enabled through WSL, but it **must only be enabled to resolve merge conflicts regarding file extension case sensitivity**.
73+
- If case sensitivity is left enabled, Visual Studio throws a lot of errors due to the way IntelliSense capitalizes paths internally.

docs/pull_request_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ This pull request aims to `(specify reason)`.
44

55
### Changes in this PR:
66

7-
- (cite all changes made in the PR for change log)
7+
- (cite all changes made in the PR for change log)
88
- Fixes/addresses issue `#<issue number>`.

0 commit comments

Comments
 (0)