OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-22 14:35:11 +01:00
Code Issues Projects Releases Packages Wiki Activity

[ci skip] Update README and CONTRIBUTING (#8917)

Browse source 
Grammar fixes and other updates
This commit is contained in:
Chris 2023-02-26 20:37:41 +01:00 committed by GitHub
parent 16fc1a175e
commit 9256248567
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.md
View file

@ -4,11 +4,11 @@ PaperMC is happy you're willing to contribute to our projects. We are usually
very lenient with all submitted PRs, but there are still some guidelines you very lenient with all submitted PRs, but there are still some guidelines you
can follow to make the approval process go more smoothly. can follow to make the approval process go more smoothly.
## Use a Personal Fork and not Organization ## Use a Personal Fork and not an Organization
Paper will routinely modify your PR, whether it's a quick rebase or to take care Paper will routinely modify your PR, whether it's a quick rebase or to take care
of any minor nitpicks we might have. Often, it's better for us to solve these of any minor nitpicks we might have. Often, it's better for us to solve these
problems for you than make you go back and forth trying to fix it yourself. problems for you than make you go back and forth trying to fix them yourself.
Unfortunately, if you use an organization for your PR, it prevents Paper from Unfortunately, if you use an organization for your PR, it prevents Paper from
modifying it. This requires us to manually merge your PR, resulting in us modifying it. This requires us to manually merge your PR, resulting in us
@ -29,9 +29,9 @@ you will most likely use this for WSL), `homebrew` (macOS / Linux), and more:
- `git` (package `git` everywhere); - `git` (package `git` everywhere);
- A Java 17 or later JDK (packages vary, use Google/DuckDuckGo/etc.). - A Java 17 or later JDK (packages vary, use Google/DuckDuckGo/etc.).
- [Adoptium](https://adoptium.net/) has builds for most operating systems. - [Adoptium](https://adoptium.net/) has builds for most operating systems.
- Paper requires JDK 17 to build, however makes use of Gradle's - Paper requires JDK 17 to build, however, makes use of Gradle's
[Toolchains](https://docs.gradle.org/current/userguide/toolchains.html) [Toolchains](https://docs.gradle.org/current/userguide/toolchains.html)
feature to allow building with only JRE 8 or later installed. (Gradle will feature to allow building with only JRE 11 or later installed. (Gradle will
automatically provision JDK 17 for compilation if it cannot find an existing automatically provision JDK 17 for compilation if it cannot find an existing
install). install).
@ -184,7 +184,7 @@ These steps assume the `origin` remote is your fork of this repository and `upst
1. Checkout feature/fix branch and rebase on master: `git checkout patch-branch && git rebase master`. 1. Checkout feature/fix branch and rebase on master: `git checkout patch-branch && git rebase master`.
1. Apply updated patches: `./gradlew applyPatches`. 1. Apply updated patches: `./gradlew applyPatches`.
1. If there are conflicts, fix them. 1. If there are conflicts, fix them.
1. If your PR creates new patches instead of modifying exist ones, in both the `Paper-Server` and `Paper-API` directories, ensure your newly-created patch is the last commit by either: 1. If your PR creates new patches instead of modifying existing ones, in both the `Paper-Server` and `Paper-API` directories, ensure your newly-created patch is the last commit by either:
* Renaming the patch file with a large 4-digit number in front (e.g. 9999-Patch-to-add-some-new-stuff.patch), and re-applying patches. * Renaming the patch file with a large 4-digit number in front (e.g. 9999-Patch-to-add-some-new-stuff.patch), and re-applying patches.
* Running `git rebase --interactive base` and moving the commits to the end. * Running `git rebase --interactive base` and moving the commits to the end.
1. Rebuild patches: `./gradlew rebuildPatches`. 1. Rebuild patches: `./gradlew rebuildPatches`.
@ -229,7 +229,7 @@ entity.getWorld().explode(new BlockPosition(spawnLocation.getX(), spawnLocation.
// Paper end // Paper end
``` ```
We generally follow usual Java style (aka. Oracle style), or what is programmed We generally follow the usual Java style (aka. Oracle style), or what is programmed
into most IDEs and formatters by default. There are a few notes, however: into most IDEs and formatters by default. There are a few notes, however:
- It is fine to go over 80 lines as long as it doesn't hurt readability. - It is fine to go over 80 lines as long as it doesn't hurt readability.
There are exceptions, especially in Spigot-related files There are exceptions, especially in Spigot-related files

2
README.md
View file

@ -4,7 +4,7 @@ Paper [![Paper Build Status](https://img.shields.io/github/actions/workflow/stat
[![Open Collective](https://img.shields.io/opencollective/all/papermc?label=OpenCollective%20Sponsors)](https://opencollective.com/papermc) [![Open Collective](https://img.shields.io/opencollective/all/papermc?label=OpenCollective%20Sponsors)](https://opencollective.com/papermc)
=========== ===========
High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies. High-performance Spigot fork that aims to fix gameplay and mechanics inconsistencies.
**Support and Project Discussion:** **Support and Project Discussion:**