diff options
| author | EvilSeph <evilseph@unaligned.org> | 2011-02-18 17:14:18 -0500 |
|---|---|---|
| committer | EvilSeph <evilseph@unaligned.org> | 2011-02-18 17:16:49 -0500 |
| commit | 97a604b83535dcdc2b378bd66932ee8762f03c55 (patch) | |
| tree | b44d196bba214f46f81f76797b23296b55430fb3 /README.md | |
| parent | 31f67329ce2f959ba8c0fc9b5b0038a819c6b704 (diff) | |
| download | bukkit-97a604b83535dcdc2b378bd66932ee8762f03c55.tar bukkit-97a604b83535dcdc2b378bd66932ee8762f03c55.tar.gz bukkit-97a604b83535dcdc2b378bd66932ee8762f03c55.tar.lz bukkit-97a604b83535dcdc2b378bd66932ee8762f03c55.tar.xz bukkit-97a604b83535dcdc2b378bd66932ee8762f03c55.zip | |
Added pull request conventions that should be followed if you want your pull requests accepted.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 5 |
1 files changed, 4 insertions, 1 deletions
@@ -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. |