Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-01-03 23:07:40 +01:00
Code Issues Projects Releases Wiki Activity
f1e98caef2
Paper/paper-api
History
Bukkit/Spigot f1e98caef2 Added javadoc generation, thanks lukegb 
By: Erik Broes <erikbroes@grum.nl>
2011-05-02 19:42:01 +02:00
..
src/main/java/org/bukkit AnimalTamer and Tameable interfaces, and corresponding features. 2011-05-03 00:36:02 +10:00
.gitignore Added /.DS_Store (Mac filesystem dust) to .gitignore (https://github.com/Bukkit/Bukkit/issues/#issue/46) 2011-01-23 04:19:03 +08:00
LICENCE.txt We're GPL. 2011-01-02 10:57:42 +01:00
pom.xml Added javadoc generation, thanks lukegb 2011-05-02 19:42:01 +02:00
README.md Updated README for line-ending demands, also fixed line-endigs. 2011-04-25 13:24:32 +02:00

README.md

Bukkit

A Minecraft Server API.

Website: http://bukkit.org
Bugs/Suggestions: http://leaky.bukkit.org

Compilation

We use maven to handle our dependencies.

  • Install Maven 3
  • Check out this repo and: mvn clean install

Coding and Pull Request 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.
  • No CRLF lineendigs, LF only, put your gits 'core.autocrlf' on 'true'
  • 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.