From 4ede622195af2ce2821b70e827699698175cd6e6 Mon Sep 17 00:00:00 2001 From: Erik Broes Date: Sat, 5 Feb 2011 15:58:03 +0100 Subject: [PATCH] Updated README.md --- README.md | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3bcc17238a..11fe85dfb3 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,6 @@ CraftBukkit 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 ----------- @@ -22,3 +12,23 @@ We use maven to handle our dependencies. * 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) * 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.