From 20a15a587cfb1066aa22f0deff5de26546101308 Mon Sep 17 00:00:00 2001 From: embeddedt <42941056+embeddedt@users.noreply.github.com> Date: Wed, 30 Aug 2023 19:22:15 -0400 Subject: [PATCH] Create CONTRIBUTING.md [skip ci] --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..bc3b5c91 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +ModernFix is a standard Minecraft-style Gradle project powered by Architectury Loom. To build the mod for all platforms, +run the `build` task (e.g. via `./gradlew build`). You can also use `./gradlew forge:build` or `./gradlew fabric:build` +to build for just one loader (e.g. when debugging and wanting to rebuild quickly). + +You must use Java 17 to develop ModernFix as the toolchain requires it. Nonetheless, the 1.16 mod JARs will work on +a Minecraft instance with Java 8. + +## Submitting pull requests + +Code or documentation contributions are welcome. Please keep the following points in mind: + +* This project supports many Minecraft versions. Ideally, contributions should be made to the oldest relevant MC version. +For instance, a PR optimizing new worldgen should be made to 1.18 (not 1.19 or 1.20) while a PR optimizing something +like recipes should be made to 1.16 (the oldest supported version). + + This somewhat unconventional policy ensures that all supported versions are treated equal when it comes to development, +rather than the onus being on other modders and players to backport changes that are needed. Changes to older versions are +quickly ported up to the latest one as part of the regular development cycle. You are still welcome to open PRs against +a newer branch if desired - but the change will likely be applied manually and not merged as a regular PR. + +* Please ensure your code is reasonably neat and sufficiently documented. Remember that self-documenting code is always +better.