From 43bfa48bfe7213a0c28ec99db50cf49bba824144 Mon Sep 17 00:00:00 2001 From: ks-hl <8331595+ks-hl@users.noreply.github.com> Date: Sun, 4 Aug 2024 10:32:27 -0400 Subject: [PATCH] Update README.md Added contributor guidelines --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 6018a6a..9c1066c 100644 --- a/README.md +++ b/README.md @@ -23,3 +23,12 @@ maven { url 'https://jitpack.io' } implementation 'com.github.Heliosares:AuxProtect:1.3.1' ``` + +## Contributors +Thank you for considering helping out. :) +Please base any PRs off of the `refactor-modules` branch, that is my working branch and has pretty significant structure changes. +### Formatting +- Ask, before you work on a PR, if the change is something I would implement. I don't want you to waste time if it's not something I want added. +- Please only change code that is necessary to your PR. +- Do not use wildcard imports. (e.g. `java.util.*`) +- Try to match the formatting of the rest of the code. (IntelliJ default autoformat with the exception of wildcard imports)