aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJ10a1n15 <45315647+j10a1n15@users.noreply.github.com>2024-06-10 08:57:28 +0200
committerGitHub <noreply@github.com>2024-06-10 08:57:28 +0200
commit91ca780d70c1633aac7eaf28d6ebb259d145c793 (patch)
treea4720cbf3250ec75e5ea8c12ac4be8238598335d /CONTRIBUTING.md
parent1fe45f026afeff9d87107380bf8c4cf58051b29f (diff)
downloadskyhanni-91ca780d70c1633aac7eaf28d6ebb259d145c793.tar.gz
skyhanni-91ca780d70c1633aac7eaf28d6ebb259d145c793.tar.bz2
skyhanni-91ca780d70c1633aac7eaf28d6ebb259d145c793.zip
Docs: Update Contributing (#2050)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md18
1 files changed, 7 insertions, 11 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c66c048f5..d4f548ddc 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -37,11 +37,11 @@ follow [their guide](https://github.com/NotEnoughUpdates/NotEnoughUpdates/blob/m
If you are not very familiar with git, you might want to try this out: https://learngitbranching.js.org/.
-_An explanation how to use intellij and branches will follow here soon.
+_An explanation how to use intellij and branches will follow here soon._
-Please use a prefix for the name of the PR (E.g. Feature, Fix, Backend, Change).
+Please use a prefix for the name of the PR (E.g. Feature, Improvement, Fix, Backend, ...).
-You can write in the description of the pr the wording for the changelog as well (optional).
+When writing the description of the PR, ensure you fill out the template with the necessary information, including the "WHAT" section, and the changelog entries.
If your PR relies on another PR, please include this information at the beginning of the description. Consider using a
format like "- #821" to illustrate the dependency.
@@ -81,8 +81,8 @@ format like "- #821" to illustrate the dependency.
- Replace it with `?:` (if null return this).
- This will most likely not be possible to avoid when working with objects from java.
- Don't forget to add `@FeatureToggle` to new standalone features (not options to that feature) in the config.
-- Do not use `e.printStackTrace()`, use `CopyErrorCommand.logError(e, "explanation for users")` instead.
-- Do not use `MinecraftForge.EVENT_BUS.post(event)`, use `event.postAndCatch()` instead.
+- Do not use `e.printStackTrace()`, use `ErrorManager.logErrorWithData(error, "explanation for users", ...extraOptionalData)` instead.
+- Do not use `MinecraftForge.EVENT_BUS.post(event)`, use `event.post()` instead.
- Do not use `toRegex()` or `toPattern()`, use `RepoPattern` instead.
- See [RepoPattern.kt](https://github.com/hannibal002/SkyHanni/blob/beta/src/main/java/at/hannibal2/skyhanni/utils/repopatterns/RepoPattern.kt)
for more information and usages.
@@ -106,20 +106,16 @@ This start script will automatically download all required libraries.
### NotEnoughUpdates
-SkyHanni requires NEU.
+SkyHanni requires **[NotEnoughUpdates](https://github.com/NotEnoughUpdates/NotEnoughUpdates/)**.
We use NEU to get auction house and bazaar price data for items and to read
the [NEU Item Repo](https://github.com/NotEnoughUpdates/NotEnoughUpdates-REPO) for item internal names, display names
and recipes.
-For more information, see https://github.com/NotEnoughUpdates/NotEnoughUpdates
-
### Config
SkyHanni stores the config (settings and user data) as a json object in a single text file.
For rendering the /sh config (categories, toggles, search, etc.),
-SkyHanni uses **MoulConfig**, the same config system as NotEnoughUpdates.
-
-For more information, see https://github.com/NotEnoughUpdates/MoulConfig
+SkyHanni uses **[MoulConfig](https://github.com/NotEnoughUpdates/MoulConfig)**, the same config system as NotEnoughUpdates.
### Elite Farmers API