Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (26 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 1.48 KB

How to contribute?

Hello there! I'm glad you'd like to make OptiGUI a better mod.

I fixed something in OptiGUI

Cool!

  1. Clone the repository
  2. Create a new branch from dev
  3. Commit your changes. Make sure to format the code and optimize imports. Use Kotlin style guide in IDEA
  4. Open a pull request to the dev branch

I want to add a translation

Cool!

  1. Clone the repository
  2. Create a new branch from dev
  3. Add your translation JSON to OptiGUI/src/main/resources/assets/optigui/lang/ folder. See en_us.jsonc for translation context
  4. Open a pull request to the dev branch
  5. I will add your GitHub display name and GitHub link to the README, the Modrinth and CurseForge pages, fabric.mod.json, and neoforge.mods.toml. If you want a different name or link, include it in the pull request description

I'd like to see a feature added to OptiGUI

  1. Create a new issue and select Request a feature template
  2. Fill in the form

OptiGUI doesn't work how it's supposed to

  1. Search the open issues to see if anyone already reported it. If not, proceed to step 2
  2. Create a new issue and select Report a bug template
  3. Fill in the form with reasonable details, so I can reproduce it, and submit the issue

OptiGUI crashed my game

  1. Search the open issues to see if anyone already reported it. If not, proceed to step 2
  2. Create a new issue and select Report a crash template
  3. Fill in the form with reasonable details, so I can reproduce it, and submit the issue