Skip to content

Contribution Guidelines #158

Open
@StillGreen-san

Description

@StillGreen-san

i think this project could benefit from contribution guidelines

including but not limited to:

  • non code contribution guides
    • already exists for translations and as issue templates
  • IDE/dev-enviroment setup
    • recommended tools
    • how to setup debug and hotreload
    • which build tool / target to use
      • what do they do (the targets)
  • which formatter should be used
    • could also be an action
  • coding style
    • naming conventions, exception handling, file structure, etc
  • pull request checklist
    • of cause changes should be tested, but maybe there are some non obvious things to look out for
    • apparently there are pull request templates like for issues, but they did not trigger for me?
  • which Java version is used
    • what about potential upgrades (Java 8 is a decade old now)
  • is Kotlin accepted in the codebase

this would take some of the guesswork out of the process, especially for people not familiar with Java and/or Minecraft server plugins. and some of it are just things that you would probably want to know regardless of familiarity

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions