[ci skip] Update contributing and maintaining instructions

CONTRIBUTING.md

@@ -27,3 +27,19 @@ Translation files are located in `src/main/resources/assets/viafabricplus/lang/`
 5. If you're changing API, make sure to update the documentation in the `docs` folder, add javadocs to your code and don't break backwards compatibility if not necessary
 6. Create a pull request and wait for it to be reviewed and merged.
 7. You're done, congrats!
+
+## Adding protocol new fixes - which are important and which aren't?
+Protocol fixes are the core functionality of ViaFabricPlus, they make ViaFabricPlus stand out from all other existing
+protocol translation platforms, and so it's even more important to keep them working.
+
+When adding new fixes, you should always check if the fix is relevant for the current version of the game. If you're unsure, 
+ask in the ViaVersion discord.
+
+In general, you should only implement changes which could be detected by the server or are relevant for the gameplay. 
+
+From experience, most changes are related to either movement or networking. If you contribute new fixes, please proof
+your changes by showing that they are relevant and also by providing a game source diff. **It's important that fixes
+are changing the actual change happend in the game and not just visual changes.**
+
+## Maintaining the mod
+See [MAINTAINING.md](docs/MAINTAINING.md) for more information on how to maintain the mod.

docs/MAINTAINING.md

@@ -1,13 +1,15 @@
 # Updating instructions for the project
+These steps are the usual process for updating ViaFabricPlus to a new version of the game. If you're unsure about something, ask in the ViaVersion discord.
 
 1. Update all upstream versions in `gradle.properties`. The main versions you need to update are:
     - `minecraft_version`
-    - `yarn_mappings`
+    - `yarn_version`
     - `loader_version`
     - `fabric_api_version`
-    - `viaversion_version`
-    - `viabackwards_version`
-    - `mod_menu_version`
+
+    - `supported_versions` (if necessary)
+   
+   As well as the versions in the `dependencies` block in the `build.gradle` file.
 2. Update the `NATIVE_VERSION` field in the ProtocolTranslator class to the new version
 3. Check all mixins in the injection package if they still apply correctly, here is a list of some critical ones:
     - `MixinClientPlayerEntity#removeBl8Boolean`
@@ -17,36 +19,67 @@
 5. Check all data dumps and diffs in the fixes/data package and update them if necessary, here is a list of some critical ones:
     - `ResourcePackHeaderDiff` (add the new version at the top of the list)
     - `ItemRegistryDiff` (add all new items/blocks added in the new version)
-6. Diff the game code with the code of the previous version (e.g. using git) and implement all changes that could be relevant for ViaFabricPlus, those are:
+6. Try to compile the mod and start porting the code until all existing fixes are working again.
+7. Diff the game code with the code of the previous version (e.g. using git) and implement all changes that could be relevant for ViaFabricPlus, those are:
     - General logic changes (e.g. `if (a && b)` -> `if (b || a)`)
     - Changes to the movement code (e.g. `player.yaw` -> `player.headYaw`)
     - Networking changes (e.g. sending a new packet / changing the packet structure)
     - Changes to visuals (e.g. animation changes)
     - Note: ViaVersion already implements most gameplay related changes for us, but you should always check for edge-cases. Since ViaVersion
-      is primarily a server side plugin, it does not take care of client-side related / deeper changes.
+      is primarily a server side plugin, it does not take care of client-side related / deeper changes. ViaFabricPlus often has to inject into
+      ViaVersion code to improve funcitonality for the client.
    
-    => If you are unsure if a change is relevant, ask in the ViaVersion discord, in general you should only implement changes
-       which could be detected by a server side anti cheat.
+    **Read more about which fixes should be added [HERE](../CONTRIBUTING.md#adding-protocol-new-fixes---which-are-important-and-which-arent)**
 
-   From experience, most changes are related to either movement or networking,
-   packages like `gametest` or `server` can be skipped usually when updating. It's important to always diff code inside 
-   the `net.minecraft.client` package as well as `net.minecraft.world` package, as these are the most likely to contain changes. (Mojang mappings)
-7. Update protocol constants in the `ViaFabricPlusProtocol` class
-8. Check the ViaVersion/upstream protocol implementation for issues and report them if necessary or if these issues can't be fixed,
+   - From experience, the following packages contain the usual important changes:
+     - `net.minecraft`
+     - `net.minecraft.client`
+        - `net.minecraft.client.gui`
+        - `net.minecraft.client.multiplayer`
+        - `net.minecraft.client.player`
+     - `net.minecraft.util`
+     - `net.minecraft.world`
+       - `net.minecraft.world.entity`
+       - `net.minecraft.world.inventory`
+       - `net.minecraft.world.item`
+       - `net.minecraft.world.level`
+         - `net.minecraft.world.level.block`
+
+   - While the following packages can be skipped completely (most of the time):
+     - `com.mojang`
+     - `net.minecraft.advancements`
+     - `net.minecraft.commands`
+     - `net.minecraft.data`
+     - `net.minecraft.gametest`
+     - `net.minecraft.realms`
+     - `net.minecraft.recipebook`
+     - `net.minecraft.references`
+     - `net.minecraft.resources`
+     - `net.minecraft.server`
+     - `net.minecraft.sounds`
+     - `net.minecraft.stats`
+     - `net.minecraft.tags`
+
+8. Update protocol constants in the `ViaFabricPlusProtocol` class
+9. Check the ViaVersion/upstream protocol implementation for issues and report them if necessary or if these issues can't be fixed,
    without tons of work, implement a workaround in ViaFabricPlus.
-9. Run the game and check all GUIs and other visuals for issues.
-10. Clean your code and make sure it is readable and understandable, clientside fixes are sorted by their protocol versions, having
+10. Run the game and check all GUIs and other visuals for issues.
+11. Clean your code and make sure it is readable and understandable, clientside fixes are sorted by their protocol versions, having
    newer fixes at the top of the file.
-11. Increment the version number in `gradle.properties` by at least a minor version (e.g. 1.0.0 -> 1.1.0)
-12. Create a pull request and wait for it to be reviewed and merged.
-13. You're done, congrats!
+12. Increment the version number in `gradle.properties` by at least a minor version (e.g. 1.0.0 -> 1.1.0)
+13. Create a pull request and wait for it to be reviewed and merged.
+14. You're done, congrats!
 
 ## Git branches
 - `main`: The main branch, this is where all changes are merged into
-- `backport/*`: Backport branches, these are used to backport newer ViaFabricPlus versions to older versions of the game
-- `recode/*`: Recode branches, these are used to port ViaFabricPlus to newer versions of the game or rewrite big parts of the code
+- `dev`: Used for changes which needs reviewing by all developers, usually merged into `main` shortly after
+- `update/*`: Update branches, these are used to port ViaFabricPlus to newer versions of the game
 - `<version>`: Final release branches sorted by their Minecraft version (e.g. `1.8.9`, `1.16.5`, `1.17.1`, ...)
 
+There are also older formats which aren't used anymore:
+- `recode/*`: Recode branches, these are used to port ViaFabricPlus to newer versions of the game or rewrite big parts of the code
+- `backport/*`: Backport branches, these are used to backport newer ViaFabricPlus versions to older versions of the game
+
 ## Versioning
 The versioning should only be updated every release and should only have one update between each release.
 - The versioning scheme is `major.minor.patch`, where: