You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+12-7
Original file line number
Diff line number
Diff line change
@@ -12,14 +12,17 @@ Welcome! Thank you for considering to contribute to Dn-FamiTracker. We really ne
12
12
13
13
## Git guidelines
14
14
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.
17
17
- 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.
19
21
20
22
### For Dn-FT maintainers:
21
23
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:
23
26
- `app-emu-module-nsf_driver-dev`
24
27
- 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.
25
28
- `docs-license-ver-meta-dev`
@@ -29,7 +32,7 @@ Welcome! Thank you for considering to contribute to Dn-FamiTracker. We really ne
29
32
- 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.
30
33
- Other branches may be made for more niche/specific modifications and fixes.
31
34
- 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.
33
36
34
37
## Dependencies and Building
35
38
@@ -64,5 +67,7 @@ To edit and/or build the source, you may use Visual Studio 2022, or alternativel
64
67
65
68
## Important Things to Note
66
69
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.
0 commit comments