mirror of
https://github.com/PaperMC/Paper.git
synced 2024-12-30 16:19:03 +01:00
Updated README.md
By: Erik Broes <erikbroes@grum.nl>
This commit is contained in:
parent
e4dc51e235
commit
a827e1d875
1 changed files with 20 additions and 10 deletions
|
@ -3,16 +3,6 @@ CraftBukkit
|
||||||
|
|
||||||
A Bukkit (Minecraft Server API) implementation
|
A Bukkit (Minecraft Server API) implementation
|
||||||
|
|
||||||
Coding Conventions
|
|
||||||
-----------
|
|
||||||
|
|
||||||
* We generally follow the Sun/Oracle coding standards.
|
|
||||||
* No tabs; use 4 spaces instead.
|
|
||||||
* No trailing whitespaces.
|
|
||||||
* No 80 column limit or midstatement newlines.
|
|
||||||
|
|
||||||
Follow the above conventions if you want your pull requests accepted.
|
|
||||||
|
|
||||||
Compilation
|
Compilation
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
|
@ -22,3 +12,23 @@ We use maven to handle our dependencies.
|
||||||
* Check out and install [Bukkit](http://github.com/Bukkit/Bukkit)
|
* Check out and install [Bukkit](http://github.com/Bukkit/Bukkit)
|
||||||
* *Note*: this is not needed as the repository we use has Bukkit too, but you might have a newer one (with your own changes :D)
|
* *Note*: this is not needed as the repository we use has Bukkit too, but you might have a newer one (with your own changes :D)
|
||||||
* Check out this repo and: `mvn clean package`
|
* Check out this repo and: `mvn clean package`
|
||||||
|
|
||||||
|
Coding Conventions
|
||||||
|
-----------
|
||||||
|
|
||||||
|
* We generally follow the Sun/Oracle coding standards.
|
||||||
|
* No tabs; use 4 spaces instead.
|
||||||
|
* No trailing whitespaces.
|
||||||
|
* No 80 column limit or 'weird' midstatement newlines.
|
||||||
|
|
||||||
|
If you make changes or add net.minecraft.server classes it is mandatory to:
|
||||||
|
|
||||||
|
* Get the files from the [mc-dev repo](https://github.com/Bukkit/mc-dev) - make sure you have the last version!
|
||||||
|
* Mark your changes with:
|
||||||
|
* 1 line; add a trailing: `// CraftBukkit [- Optional reason]`
|
||||||
|
* 2+ lines; add
|
||||||
|
* Before: `// CraftBukkit start [- Optional comment]`
|
||||||
|
* After: `// CraftBukkit end`
|
||||||
|
* Keep the diffs to a minimum (*really* important)
|
||||||
|
|
||||||
|
Follow the above conventions if you want your pull requests accepted.
|
||||||
|
|
Loading…
Reference in a new issue