PaperMC/paper-server
CraftBukkit/Spigot f883848b8d When deprecating, the alternative should be provided.
By: EvilSeph <evilseph@unaligned.org>
2011-02-19 06:02:27 -05:00
..
src/main/java/org/bukkit/craftbukkit When deprecating, the alternative should be provided. 2011-02-19 06:02:27 -05:00
.gitignore Modified .gitignore to remove Mac filesystem dust (/.DS_Store) 2011-01-23 08:38:40 +08:00
LGPL.txt We're LGPL. 2011-01-02 10:58:11 +01:00
LICENCE.txt We're LGPL. 2011-01-02 10:58:11 +01:00
pom.xml That messed up Jenkins 2011-02-15 22:55:23 +01:00
README.md Added pull request conventions that should be followed if you want your pull request accepted. 2011-02-18 17:15:19 -05:00

CraftBukkit

A Bukkit (Minecraft Server API) implementation

Compilation

We use maven to handle our dependencies.

  • Install Maven 3
  • Check out and install 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)
  • Check out this repo and: mvn clean package

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 'weird' midstatement newlines.
  • 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.

If you make changes or add net.minecraft.server classes it is mandatory to:

  • Get the files from the mc-dev repo - 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.