mirror of
https://github.com/LeavesMC/Leaves.git
synced 2025-12-19 14:59:32 +00:00
d5c9306a7f
* init 1.21.4, and boom! * build change, but weight not work * just work * Build changes, and delete timings * Fix API patches (#406) * Fix API patches * merge --------- Co-authored-by: violetc <58360096+s-yh-china@users.noreply.github.com> * 0006/0129 * 0009/0129 * 0011/0129 * 0018/0129 * 0030/0129 * 0035/0129 * 0043/0129 * 0048/0129 * 0049/0129 * 0057/0129 * 0065/0129 * 0086/0129 (#408) * 0072/0129 * 0080/0129 * Readd patch infos * 0086/0129 * Delete applied patches * 0087/0129 * 0091/0129 * 0097/0129 * 0101/0129 * 102/129 * 0107/0129 * 0112/0129 * 0118/0129 * 0129/0129, 100% patched * fix some * server work * Protocol... (#409) * Jade v7 * Fix changed part for Jade * Formatting imports, add Lms Paster protocol * REI payloads 5/8 * Add REI support, remove unnecessary content in Jade * Rename * Make jade better * Make action work * fix action jar * Fix some protocol * Fix bot action, and entity tickCount * Fix Warden GameEventListener register on load * Fix extra Raider drop * Fix grindstone overstacking * Update Paper, and some doc * Merge * [ci skip] Update Action --------- Co-authored-by: Lumine1909 <133463833+Lumine1909@users.noreply.github.com>
75 lines
3.0 KiB
Markdown
75 lines
3.0 KiB
Markdown
Contributing to Leaves
|
|
===========
|
|
|
|
**English** | [中文](https://github.com/LeavesMC/Leaves/blob/master/docs/CONTRIBUTING_cn.md)
|
|
|
|
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're some small problems, we'll help you solve them by editing your PR.
|
|
|
|
But, if your PR is from a organization, we can NOT edit your PR, so we must merge your PR manually.
|
|
|
|
So, don't use orgnization accounts for fork!
|
|
|
|
See also [This issue](https://github.com/isaacs/github/issues/1681), and then you'll know why we can't edit PRs from organizations.
|
|
|
|
## Development Environment
|
|
|
|
Before coding, you need these softwares / tools as Dev Environment.
|
|
|
|
- `git`
|
|
- `JDK 21 or higher`
|
|
- We used Gradle's toolchains, so you can build Leaves using JRE 8. (When Gradle can't find JDK 21, it will download it automatically.)
|
|
|
|
If you're using Windows Operating System, you can use `WSL` to speed up building.
|
|
|
|
## Understanding "Patches"
|
|
|
|
Leaves uses as the same patching system as Paper,
|
|
and has been divided into two directories for the purpose of modifying different parts of it:
|
|
|
|
- `leaves-api` - Modifications to `Paper-API` / `Spigot-API` / `Bukkit`.
|
|
- `leaves-server` - Modifications to `Paper` / `Spigot` / `CraftBukkit`.
|
|
|
|
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:
|
|
|
|
1. Clone your repository to local
|
|
2. Run Gradle's `applyAllPatches` task in your IDE or terminal (You can run `./gradlew applyAllPatches` directly in terminal.)
|
|
3. Enter `leaves-api` or `leaves-server` directory to carry out modifications.
|
|
|
|
BTW, `leaves-api` and `leaves-server` 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 Leaves' patches.
|
|
|
|
## Adding new patches
|
|
|
|
It's very easy to to add patches by following the steps below:
|
|
|
|
1. Modify the code of `leaves-api` and / or `leaves-server`
|
|
2. Add these changes to the local git repository (For example, `git add .`)
|
|
3. Commit these changes using `git commit -m <Commit Message>`
|
|
4. Run Gradle's task `rebuildAllServerPatches` to convert your commits to a new patch
|
|
5. Push your patches to your repository
|
|
|
|
After pushing, you can open a PR to submit your patches.
|
|
|
|
## Modifying patches
|
|
|
|
You can modify a existing patch by following the steps below:
|
|
|
|
1. Modify code at HEAD
|
|
2. Run `git commit -a --fixup <hash>` in your terminal to make a fix-up commit
|
|
- If you want to edit the commit message, replace `--fixup` with `--squash`.
|
|
3. Run `git rebase -i --autosquash base` to rebase automatically, then just type `:q` to close the confirm page
|
|
4. Run Gradle's task `rebuildAllServerPatches` to modify existing patches
|
|
5. Push and PR again
|