Commits
md_5 authored 6a2f313af1e
1 1 | Bukkit |
2 2 | ====== |
3 + | A plugin API for [Minecraft](https://minecraft.net/) servers, currently maintained by [SpigotMC](http://www.spigotmc.org/). |
3 4 | |
4 - | A Minecraft Server API. |
5 - | |
6 - | Website: [http://bukkit.org](http://bukkit.org) |
7 - | Bugs/Suggestions: [http://leaky.bukkit.org](http://leaky.bukkit.org) |
8 - | Contributing Guidelines: [CONTRIBUTING.md](https://github.com/Bukkit/Bukkit/blob/master/CONTRIBUTING.md) |
5 + | Bug Reporting |
6 + | ------------- |
7 + | 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/). |
9 8 | |
10 9 | Compilation |
11 10 | ----------- |
11 + | Bukkit is a Java program which uses [Maven 3](http://maven.apache.org/) for compilation. To compile fresh from Git, simply perform the following steps: |
12 + | * Install Maven and Git using your preferred installation methods. |
13 + | * `git clone https://hub.spigotmc.org/stash/scm/spigot/bukkit.git`. |
14 + | * `mvn clean install`. |
15 + | |
16 + | 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 Bukkit, however the current team's personal preference is to use NetBeans. |
12 17 | |
13 - | We use maven to handle our dependencies. |
14 - | |
15 - | * Install [Maven 3](http://maven.apache.org/download.html) |
16 - | * Check out this repo and: `mvn clean install` |
18 + | Contributing |
19 + | ------------ |
20 + | 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: |
21 + | * Create an account on [JIRA](http://hub.spigotmc.org/jira/). |
22 + | * 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. |
23 + | * Log into Stash using your JIRA credentials. |
24 + | |
25 + | Once you have performed these steps you can create a fork, push your code changes, and then submit it for review. |