Skip to content

Commit ab94fb6

Browse files
committed
A few tweaks to the Contributing Guide
1 parent bd79c8b commit ab94fb6

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

docs/CONTRIBUTING.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -122,30 +122,27 @@ Also only report one issue or enhancement at a time! If you have multiple bug re
122122

123123
Once you're sure your issue is unique and specific, feel free to submit it.
124124

125-
> [!IMPORTANT]
126-
> **DO NOT CLOSE YOUR ISSUE FOR ANY REASON!** Your issue will be taken care of by a moderator!
127-
128125
**Thank you for opening issues!**
129126

130127
# Part 3: Pull Requests
131128
Community members are welcome to contribute their changes by [opening pull requests](https://github.com/FunkinCrew/Funkin/pulls).
132129
This section covers guidelines for opening and managing pull requests (PRs).
133130

134131
## 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.
136133

137134
> [!CAUTION]
138135
> 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!
139136
> Instead, make a separate branch for your additions (ex. `docs/fix-typo` or `minor-bugfix`).
140137
141-
Choose the `main` branch if you modify:
142-
- Documentation (`.md` files)
143-
- GitHub files (`.yml` files or anything in the `.github` folder)
144-
145138
Choose the `develop` branch if you modify:
146139
- Game code (`.hx` files)
147140
- Any other type of file
148141

142+
Choose the `main` branch if you modify:
143+
- Documentation (`.md` files)
144+
- GitHub files (`.yml` files or anything in the `.github` folder)
145+
149146
> [!TIP]
150147
> When in doubt, base your branch on the `develop` branch.
151148
@@ -399,7 +396,7 @@ If you only modify files in the `assets` folder, open a PR in the `funkin.assets
399396

400397
If you simultaneously modify files from both repositories, then open two separate PRs and explain the connection in your PR descriptions.
401398

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.
403400

404401
### Charting PRs
405402
Charting PRs make changes such as **adjusting chart metadata**.

0 commit comments

Comments
 (0)