Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (19 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 2.14 KB

Contributing

Pull Requests

Before submitting a change, make sure to run tools/lint.py to verify that your source files are formatted like the rest of the repository.

Linter arguments:

  • --fix: Try to fix the formatting issues automatically.
  • --format: Run clang-format before checks.
  • --find-unsorted: Find unsorted classes/enums in the source files.

GitHub Actions will run on your PR to verify that your code has been linted and clang formatted.

It is recommended that you name your PR in this fashion:

  • Matching implementation of a class or method: "Implement Name"
  • Non-matching / incomplete implementation of a class or method: "Work on Name"
  • Completion of a class or method: "Complete Name"

You can add anything you want after the message. Your pull request will be squashed and merged, so don't stress too much about the makeup of the individual commits.

Warning: Make sure to backup your changes before running an automatic fix! The linter is experimental and could break your files.

Info

As this project is in its very early stages, its hard to put guidelines on something that will evolve over time as contributors gain a better understanding of the game's internals.

While almost all source paths aren't known, a few .cpp file names do appear in the Wii U Edition's global static constructors, along with a couple asserts giving file paths. Follow these file names wherever possible.

Another point of reference is the Switch Edition, showing us the file path to Minecraft.World/Calendar.cpp and some other files in that folder. World generation should be stored in this folder based on MinecraftWorld_RunStaticCtors routing all worldgen static constructors inside of the folder.

For another point of reference, you could also look at the Minecraft: Pocket Edition decompilation for more inspiration. As a matter of fact, a lot of classes from that decompilation project share function names with this game's symbols. Both editions originated from Notch's messy Minecraft beta code, so it's no wonder that a lot of names were probably copied from Mojang's official mappings at the time.