Contributing to Luminol

English | 中文

We're glad that you want to contribute to our project!
In general, our review of pull requests is very lenient.
And if you can follow the rules below, we can complete the review faster.

Please fork using your personal account

We regularly merge existing PRs.
If there are some small problems, we'll help you solve them by editing your PR.

But, if your PR is from an organization, we can NOT edit your PR, so we must merge your PR manually.

So, don't use organization accounts for fork!

See also This issue, and then you'll know why we can't edit PRs from organizations.

Development Environment

Before coding, you need these pieces of software / tools as Dev Environment.

git
JDK 21 or higher

PS: You need to enable long path support in your System and Git before start, some of the platform's resolution here.

Windows Git for Windows

Understanding "Patches"

Luminol uses as the same patching system as Paper,
and has been divided into two directories for the purpose of modifying different parts of it:

luminol-api - Modifications to Folia-API / Paper-API / Spigot-API / Bukkit-API.
luminol-server - Modifications to Minecraft Vanilla Server's source logic.

The patching system is based on git, and you can learn about it at here: https://git-scm.com/docs/gittutorial

If you have forked the main repository, then you should follow the steps below:

Clone your repository to local
Run Gradle's applyAllPatches task in your IDE or terminal (You can run ./gradlew applyAllPatches directly in terminal.)
After performing the operation, the following directory pairs should exist in the root directory of the warehouse: luminol-api and luminol-server , folia-api and folia-server , paper-api and paper-server (Referred to *-api and *-server as below)
Enter *-api and *-server directory to carry out modifications.

The following is the simple description of the aforementioned folders, detailed description can be referred to here:

API part

luminol-api : There is no valid file
folia-api : Modifications to Folia API should be carried out in this folder
paper-api : Modifications to Paper API/Spigot API/Bukkit API should be carried out in this folder

Server part

luminol-server : Modifications to Minecraft Vanilla Server's source logic should be carried out in this folder
folia-server : There is no valid file
paper-server : Modifications to non-vanilla server logic should be carried out in this folder

BTW, *-api and *-server and are not normal git repositories.

Before applying patches, the base will point to unmodified source code.
Every commit after the base is a patch.
Only commits after the last commit of Paper will be considered as Luminol patches.

Adding new patches

It's very easy to add patches by following the steps below:

Modify the code of *-api and *-server
Add these changes to the local git repository (For example, git add .)
Commit these changes using git commit -m <Commit Message> (PS: do not commit new-created files)
Run Gradle's task fixupPaperApiFilePatches to generate newly created files to new patches (PS: do not commit again before you run this task)
Run Gradle's task rebuildAllServerPatches to convert your commits to a new patch
Push your patches to your repository

After pushing, you can open a PR to submit your patches.

Modifying patches

You can modify an existing patch by following the steps below:

Modify code at HEAD
Run git commit -a --fixup <hash> in your terminal to make a fix-up commit (PS: do not commit changes of luminol-created files)
- If you want to edit the commit message, replace --fixup with --squash
Run git rebase -i --autosquash base to rebase automatically, then just type :q to close the confirm page
Run Gradle's task fixupPaperApiFilePatches to regenerate luminol-created files to patches (PS: do not commit again before you run this task)
Run Gradle's task rebuildAllServerPatches to modify existing patches
Push and PR again

4.5 KiB Raw Blame History