OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-30 16:19:03 +01:00
Code Issues Projects Releases Packages Wiki Activity

Added pull request conventions that should be followed if you want your pull requests accepted.

Browse source 
By: EvilSeph <evilseph@unaligned.org>
This commit is contained in:
Bukkit/Spigot 2011-02-18 17:14:18 -05:00
parent d7633fa07b
commit 77a963e3eb
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
paper-api/README.md
View file

@ -11,7 +11,7 @@ We use maven to handle our dependencies.
* Install [Maven 3](http://maven.apache.org/download.html)
* Check out this repo and: `mvn clean install`
Coding Conventions
Coding and Pull Request Conventions
-----------
* We generally follow the Sun/Oracle coding standards.
@ -19,5 +19,8 @@ Coding Conventions
* No trailing whitespaces.
* No 80 column limit or midstatement newlines.
* Proper javadoc for each method added/changed to describe what it does.
* The number of commits in a pull request should be kept to a minimum (squish them into one most of the time - use common sense!).
* No merges should be included in pull requests unless the pull request's purpose is a merge.
* Pull requests should be tested (does it compile? AND does it work?) before submission.
Follow the above conventions if you want your pull requests accepted.