aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorLinnea Gräf <nea@nea.moe>2023-12-30 22:13:17 +0100
committerGitHub <noreply@github.com>2023-12-30 22:13:17 +0100
commitd5e90ae076d3e9de41af390f5c05545437b0415e (patch)
tree79ed44ee6e909becbee70e86ae65070cfd24d3ec /CONTRIBUTING.md
parentc7fff0313b9f06b4b01ebc93580182b585ec9def (diff)
downloadskyhanni-d5e90ae076d3e9de41af390f5c05545437b0415e.tar.gz
skyhanni-d5e90ae076d3e9de41af390f5c05545437b0415e.tar.bz2
skyhanni-d5e90ae076d3e9de41af390f5c05545437b0415e.zip
Fix minor inaccuracies in CONTRIBUTING (#864)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b33db983d..1b439bc15 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -119,9 +119,14 @@ All data sent is anonymonized and opt-in.
### Mixin
A system to inject code into the original Minecraft code.
-This library is not part of SkyHanni itself; it comes preinstalled with Forge.
+This library is not part of SkyHanni or Forge, but we bundle it.
-For more information, see https://github.com/SpongePowered/Mixin.
+It allows to easily modify methods in Minecraft itself, without conflicting with other mods.
+
+For more information, see https://github.com/SpongePowered/Mixin or [our existing mixins](https://github.com/hannibal002/SkyHanni/tree/beta/src/main/java/at/hannibal2/skyhanni/mixins/transformers).
+
+When creating new Mixins, try to keep the code inside of the mixin as small as possible, and calling a hook as soon as
+possible.
### Repo
@@ -143,7 +148,7 @@ at [DiscordRPCManager.kt](https://github.com/hannibal002/SkyHanni/blob/beta/src/
### Auto Updater
-We use the [auto update library](https://repo.nea.moe/#/releases/moe/nea/libautoupdate) from nea.
+We use the [auto update library](https://github.com/nea89o/libautoupdate) from nea89.
## Additional Useful Developement Tools