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
+6-9Lines changed: 6 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -122,30 +122,27 @@ Also only report one issue or enhancement at a time! If you have multiple bug re
122
122
123
123
Once you're sure your issue is unique and specific, feel free to submit it.
124
124
125
-
> [!IMPORTANT]
126
-
> **DO NOT CLOSE YOUR ISSUE FOR ANY REASON!** Your issue will be taken care of by a moderator!
127
-
128
125
**Thank you for opening issues!**
129
126
130
127
# Part 3: Pull Requests
131
128
Community members are welcome to contribute their changes by [opening pull requests](https://github.com/FunkinCrew/Funkin/pulls).
132
129
This section covers guidelines for opening and managing pull requests (PRs).
133
130
134
131
## Choosing a base branch
135
-
When creating a branch in your fork, base your branch on either the `main` or `develop` branch depending on the types of changes you want to make.
132
+
When creating a branch in your fork, base your branch on either the `develop` or `main` branch depending on the types of changes you want to make.
136
133
137
134
> [!CAUTION]
138
135
> Avoid using your fork's default branch (`main` in this case) for your PR. This is considered an [anti-pattern](https://jmeridth.com/posts/do-not-issue-pull-requests-from-your-master-branch/) by GitHub themselves!
139
136
> Instead, make a separate branch for your additions (ex. `docs/fix-typo` or `minor-bugfix`).
140
137
141
-
Choose the `main` branch if you modify:
142
-
- Documentation (`.md` files)
143
-
- GitHub files (`.yml` files or anything in the `.github` folder)
144
-
145
138
Choose the `develop` branch if you modify:
146
139
- Game code (`.hx` files)
147
140
- Any other type of file
148
141
142
+
Choose the `main` branch if you modify:
143
+
- Documentation (`.md` files)
144
+
- GitHub files (`.yml` files or anything in the `.github` folder)
145
+
149
146
> [!TIP]
150
147
> When in doubt, base your branch on the `develop` branch.
151
148
@@ -399,7 +396,7 @@ If you only modify files in the `assets` folder, open a PR in the `funkin.assets
399
396
400
397
If you simultaneously modify files from both repositories, then open two separate PRs and explain the connection in your PR descriptions.
401
398
402
-
Be sure to choose `main` as the base branch for `funkin.assets` PRs, as no `develop` branch exists for that repository.
399
+
Be sure to choose `develop` as the base branch for `funkin.assets` PRs, just as you would in the `Funkin` repository.
403
400
404
401
### Charting PRs
405
402
Charting PRs make changes such as **adjusting chart metadata**.
0 commit comments