Skip to content

Contribute

Kevin edited this page Jan 18, 2024 · 3 revisions

We welcome contributions from anyone for any feature related to Hypixel Skyblock.

Code Style

For code style, try to follow the Fabric Development Guidelines.

Documenting your code with Javadocs or comments is strongly encouraged.

Mixin

Prefer fabric events over any mixins. Prefer mixin extras over invasive mixins such as redirects.

Config

Remember to add configuration to your feature! Since Skyblocker 1.15, we use YACL as your config library. You need to add config fields to SkyblockerConfig and add an entry to the respective category, such as DungeonsCategory. You will also need to add the English localization to en_us.json. Additionally, we try to keep these three files (config class, category class, and English localization file) in the same order to minimize confusion.

Testing

We encourage testing your features thoroughly before submitting a PR. Screenshots or showcases would additionally accelerate the review process of your PR. Please note clearly in the PR if it has not been tested.

Unit tests are also strongly encouraged. Note that you can create unit tests for methods containing Minecraft classes. See ItemUtilsTest for an example.


Thank you for contributing to Skyblocker and have fun!