diff options
author | Xor Boole <mcyoung@mit.edu> | 2015-03-19 18:27:31 -0400 |
---|---|---|
committer | md_5 <git@md-5.net> | 2015-07-22 19:11:18 +1000 |
commit | a3cb1bcd92a284fb6c86a7634d5842bd68ef8d81 (patch) | |
tree | 0c3cf77a596a1b2916a7363a3cb1069b2f9784e8 /README.md | |
parent | 58d972f1ddc6fad892e7b7cee0ae1290a1bfe459 (diff) | |
download | craftbukkit-a3cb1bcd92a284fb6c86a7634d5842bd68ef8d81.tar craftbukkit-a3cb1bcd92a284fb6c86a7634d5842bd68ef8d81.tar.gz craftbukkit-a3cb1bcd92a284fb6c86a7634d5842bd68ef8d81.tar.lz craftbukkit-a3cb1bcd92a284fb6c86a7634d5842bd68ef8d81.tar.xz craftbukkit-a3cb1bcd92a284fb6c86a7634d5842bd68ef8d81.zip |
Give the README a small update.
It could probably use even more love in the future.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 36 |
1 files changed, 25 insertions, 11 deletions
@@ -1,18 +1,32 @@ CraftBukkit -=========== +====== +An implemenation of the [Bukkit](https://hub.spigotmc.org/stash/projects/SPIGOT/repos/bukkit) plugin API for [Minecraft](https://minecraft.net/) servers, currently maintained by [SpigotMC](http://www.spigotmc.org/). -A Bukkit (Minecraft Server API) implementation - -Website: [http://bukkit.org](http://bukkit.org) -Bugs/Suggestions: [http://leaky.bukkit.org](http://leaky.bukkit.org) -Contributing Guidelines: [CONTRIBUTING.md](https://github.com/Bukkit/CraftBukkit/blob/master/CONTRIBUTING.md) +Bug Reporting +------------- +The development team is very open to both bug and feature requests / suggestions. You can submit these on the [JIRA Issue Tracker](http://hub.spigotmc.org/jira/). Compilation ----------- +CraftBukkit is a Java program which uses [Maven 3](http://maven.apache.org/) for compilation. To compile fresh from Git, simply perform the following steps: + +* Install Git using your preferred installation methods. +* Download and run [BuildTools](https://www.spigotmc.org/wiki/buildtools/) + +Some IDEs such as [NetBeans](https://netbeans.org/) can perform these steps for you. Any Maven capable Java IDE can be used to develop with CraftBukkit, however the current team's personal preference is to use NetBeans. + +Contributing +------------ +Contributions of all sorts are welcome. To manage community contributions, we use the pull request functionality of Stash. In to gain access to Stash and create a pull request, you will first need to perform the following steps: -We use maven to handle our dependencies. +* Create an account on [JIRA](http://hub.spigotmc.org/jira/). +* Fill in the [SpigotMC CLA](http://www.spigotmc.org/go/cla) and wait up to 24 hours for your Stash account to be activated. Please ensure that your username and email addresses match. +* Log into Stash using your JIRA credentials. + +Once you have performed these steps you can create a fork, push your code changes, and then submit it for review. -* Install [Maven 3](http://maven.apache.org/download.html) -* 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` +If you submit a PR involving both Bukkit and CraftBukkit, it's appreciated if each PR links the other. Additionally, every reference to an obfuscated field/method in NMS should be marked with `// PAIL: Rename` and optionally a suggested name, to make mapping creation easier. E.g.: +``` + entity.k.get(i).f(); // PAIL Rename pathfinders, navigateToHome +``` +Also, make sure to include `// Craftbukkit` comments to indicate modified NMS sources. |