summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorErik Broes <erikbroes@grum.nl>2011-02-05 15:58:03 +0100
committerErik Broes <erikbroes@grum.nl>2011-02-05 16:03:40 +0100
commit4ede622195af2ce2821b70e827699698175cd6e6 (patch)
treec866d4075e974a9ae10fc7099fa2fdfb498c2fc6 /README.md
parent101d01ef644c29da1393bdd325a910f7aa5cf097 (diff)
downloadcraftbukkit-4ede622195af2ce2821b70e827699698175cd6e6.tar
craftbukkit-4ede622195af2ce2821b70e827699698175cd6e6.tar.gz
craftbukkit-4ede622195af2ce2821b70e827699698175cd6e6.tar.lz
craftbukkit-4ede622195af2ce2821b70e827699698175cd6e6.tar.xz
craftbukkit-4ede622195af2ce2821b70e827699698175cd6e6.zip
Updated README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 20 insertions, 10 deletions
diff --git a/README.md b/README.md
index 3bcc1723..11fe85df 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.