core
/
testserver
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Contributing.md for 1.9 name/repo changes

This commit is contained in:
Zach Brown 2016-03-15 12:51:03 -05:00
parent f8539b5e7b
commit 86a8f39fea
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Contributing.md
View File

@ -1,27 +1,27 @@
Contributing to PaperSpigot
Contributing to Paper
==========================
PaperSpigot has a very lenient policy towards PRs, but would prefer that you try and adhere to the following guidelines.
PaperMC has a very lenient policy towards PRs, but would prefer that you try and adhere to the following guidelines.
## Understanding Patches
Patches to PaperSpigot are very simple, but center around the directories 'PaperSpigot-API' and 'PaperSpigot-Server'
Patches to Paper are very simple, but center around the directories 'Paper-API' and 'Paper-Server'
Assuming you already have forked the repository:
1. Pull the latest changes from the main repository
2. Type `./applyPatches.sh` in git bash to apply the changes from upstream
3. cd into `PaperSpigot-Server` for server changes, and `PaperSpigot-API` for api changes
3. cd into `Paper-Server` for server changes, and `Paper-API` for api changes
These directories aren't git repositories in the traditional sense:
- Every single commit in PaperSpigot-Server/API is a patch.
- 'origin/master' points to a directory similar to PaperSpigot-Server/API but for PaperSpigot
- Typing `git status` should show that we are 10 or 11 commits ahead of master, meaning we have 10 or 11 patches that PaperSpigot and Spigot don't
- If it says something like `212 commits ahead, 207 commits behind`, then type `git fetch` to update spigot/paperspigot
- If it says something like `212 commits ahead, 207 commits behind`, then type `git fetch` to update spigot/paper
## Adding Patches
Adding patches to PaperSpigot is very simple:
Adding patches to Paper is very simple:
1) Modify `PaperSpigot-Server` and/or `PaperSpigot-API` with the appropriate changes
1) Modify `Paper-Server` and/or `Paper-API` with the appropriate changes
2) Type `git add .` to add your changes
3) Run `git commit` with the desired patch message
4) Run `./rebuildPatches.sh` in the main directory to convert your commit into a new patch
@ -56,22 +56,22 @@ While we will fix minor formatting issues, you should stick to the guide below w
## Formatting
All modifications to non-PaperSpigot files should be marked
- Multi line changes start with `// PaperSpigot start` and end with `// PaperSpigot end`
- You can put a messages with a change if it isn't obvious, like this: `// PaperSpigot start - reason
- Multi line changes start with `// Paper start` and end with `// Paper end`
- You can put a messages with a change if it isn't obvious, like this: `// Paper start - reason
- Should generally be about the reason the change was made, what it was before, or what the change is
- Multi-line messages should start with `// PaperSpigot start` and use `/* Multi line message here */` for the message itself
- Single line changes should have `// PaperSpigot` or `// PaperSpigot - reason`
- Multi-line messages should start with `// Paper start` and use `/* Multi line message here */` for the message itself
- Single line changes should have `// Paper` or `// Paper - reason`
- For example:
````java
entity.getWorld().dontbeStupid(); // PaperSpigot - was beStupid() which is bad
entity.getWorld().dontbeStupid(); // Paper - was beStupid() which is bad
entity.getFriends().forEach(Entity::explode());
entity.a();
entity.b();
// PaperSpigot start - use plugin-set spawn
// Paper start - use plugin-set spawn
// entity.getWorld().explode(entity.getWorld().getSpawn());
Location spawnLocation = ((CraftWorld)entity.getWorld()).getSpawnLocation();
entity.getWorld().explode(new BlockPosition(spawnLocation.getX(), spawnLocation.getY(), spawnLocation.getZ()));
// PaperSpigot end
// Paper end
````
- We generally follow usual java style, or what is programmed into most IDEs and formatters by default
- This is also known as oracle style