Skip to content

Commit 06f5441

Browse files
committed
Merge 1.16 into 1.18
2 parents 987c5dc + fcde610 commit 06f5441

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
ModernFix is a standard Minecraft-style Gradle project powered by Architectury Loom. To build the mod for all platforms,
2+
run the `build` task (e.g. via `./gradlew build`). You can also use `./gradlew forge:build` or `./gradlew fabric:build`
3+
to build for just one loader (e.g. when debugging and wanting to rebuild quickly).
4+
5+
You must use Java 17 to develop ModernFix as the toolchain requires it. Nonetheless, the 1.16 mod JARs will work on
6+
a Minecraft instance with Java 8.
7+
8+
## Submitting pull requests
9+
10+
Code or documentation contributions are welcome. Please keep the following points in mind:
11+
12+
* This project supports many Minecraft versions. Ideally, contributions should be made to the oldest relevant MC version.
13+
For instance, a PR optimizing new worldgen should be made to 1.18 (not 1.19 or 1.20) while a PR optimizing something
14+
like recipes should be made to 1.16 (the oldest supported version).
15+
16+
This somewhat unconventional policy ensures that all supported versions are treated equal when it comes to development,
17+
rather than the onus being on other modders and players to backport changes that are needed. Changes to older versions are
18+
quickly ported up to the latest one as part of the regular development cycle. You are still welcome to open PRs against
19+
a newer branch if desired - but the change will likely be applied manually and not merged as a regular PR.
20+
21+
* Please ensure your code is reasonably neat and sufficiently documented. Remember that self-documenting code is always
22+
better.

0 commit comments

Comments
 (0)