aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorhannibal2 <24389977+hannibal00212@users.noreply.github.com>2023-09-02 11:22:02 +0200
committerhannibal2 <24389977+hannibal00212@users.noreply.github.com>2023-09-02 11:22:02 +0200
commit653c95679ba5dd59cfc5c1129c124f99aa8ed47b (patch)
tree52e622d8f020996d20155fc2d570befb9d4bcc99 /CONTRIBUTING.md
parent23582658340b9ac748ab2205b754e0ddfa38936d (diff)
downloadskyhanni-653c95679ba5dd59cfc5c1129c124f99aa8ed47b.tar.gz
skyhanni-653c95679ba5dd59cfc5c1129c124f99aa8ed47b.tar.bz2
skyhanni-653c95679ba5dd59cfc5c1129c124f99aa8ed47b.zip
discourage the use of !!
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 23433bfc8..0d8cd5827 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -63,9 +63,11 @@ For more information, see https://github.com/NotEnoughUpdates/MoulConfig
## Elite Farmers API
-SkyHanni utilizes the [Elite API](https://api.elitebot.dev/) (view the [public site here](https://elitebot.dev)) for some farming features.
+SkyHanni utilizes the [Elite API](https://api.elitebot.dev/) (view the [public site here](https://elitebot.dev)) for
+some farming features.
-This includes features relating to Farming Weight, as well as syncing jacob contests amongst players for conviencience. All data sent is anonymonized and opt-in.
+This includes features relating to Farming Weight, as well as syncing jacob contests amongst players for conviencience.
+All data sent is anonymonized and opt-in.
## Mixin
@@ -91,7 +93,6 @@ the [original](https://github.com/jagrosh/DiscordIPC).
For info on usage, look
at [DiscordRPCManager.kt](https://github.com/hannibal002/SkyHanni/blob/beta/src/main/java/at/hannibal2/skyhanni/features/misc/discordrpc/DiscordRPCManager.kt)
-
## Auto Updater
We use the [auto update library](https://repo.nea.moe/#/releases/moe/nea/libautoupdate) from nea.
@@ -120,6 +121,9 @@ We use the [auto update library](https://repo.nea.moe/#/releases/moe/nea/libauto
- Please try to avoid using `System.currentTimeMillis()`. Use our own class `SimpleTimeMark` instead.
- See [this commit](https://github.com/hannibal002/SkyHanni/commit/3d748cb79f3a1afa7f1a9b7d0561e5d7bb284a9b)
as an example.
+- Try to avoid using kotlin's `!!` (catch if not null) feature.
+ - Replace it with `?:` (ff null return this).
+ - This will most likely not be possible to avoid when working with obects from java.
# Additional Useful Developement Tools