2011-01-03 19:17:31 +01:00
|
|
|
Bukkit
|
|
|
|
|
======
|
|
|
|
|
|
|
|
|
|
A Minecraft Server API.
|
|
|
|
|
|
2011-02-05 16:11:37 +01:00
|
|
|
Compilation
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
We use maven to handle our dependencies.
|
|
|
|
|
|
|
|
|
|
* Install [Maven 3](http://maven.apache.org/download.html)
|
|
|
|
|
* Check out this repo and: `mvn clean install`
|
|
|
|
|
|
2011-02-18 23:14:18 +01:00
|
|
|
Coding and Pull Request Conventions
|
2011-02-03 22:13:44 +01:00
|
|
|
-----------
|
|
|
|
|
|
2011-02-03 22:15:00 +01:00
|
|
|
* We generally follow the Sun/Oracle coding standards.
|
|
|
|
|
* No tabs; use 4 spaces instead.
|
|
|
|
|
* No trailing whitespaces.
|
|
|
|
|
* No 80 column limit or midstatement newlines.
|
2011-02-05 16:11:37 +01:00
|
|
|
* Proper javadoc for each method added/changed to describe what it does.
|
2011-02-18 23:14:18 +01:00
|
|
|
* 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.
|
2011-02-03 22:13:44 +01:00
|
|
|
|
|
|
|
|
Follow the above conventions if you want your pull requests accepted.
|
