From 925624856712adb911afdd9cfd18b87d32aed5ab Mon Sep 17 00:00:00 2001 From: Chris <65610536+Chris6ix@users.noreply.github.com> Date: Sun, 26 Feb 2023 20:37:41 +0100 Subject: [PATCH] [ci skip] Update README and CONTRIBUTING (#8917) Grammar fixes and other updates --- CONTRIBUTING.md | 12 ++++++------ README.md | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb0ca036dd..3477e70dc5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 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 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 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); - A Java 17 or later JDK (packages vary, use Google/DuckDuckGo/etc.). - [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) - 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 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. Apply updated patches: `./gradlew applyPatches`. 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. * Running `git rebase --interactive base` and moving the commits to the end. 1. Rebuild patches: `./gradlew rebuildPatches`. @@ -229,7 +229,7 @@ entity.getWorld().explode(new BlockPosition(spawnLocation.getX(), spawnLocation. // 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: - It is fine to go over 80 lines as long as it doesn't hurt readability. There are exceptions, especially in Spigot-related files diff --git a/README.md b/README.md index 9e509d6477..b2fd4a3ece 100644 --- a/README.md +++ b/README.md @@ -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) =========== -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:**