Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-01-01 05:47:45 +01:00
Code Issues Projects Releases Wiki Activity

#736: Update README

Browse Source 
By: Doc <nachito94@msn.com>
This commit is contained in:
Bukkit/Spigot 2022-03-24 13:39:30 +11:00
parent 3c7b2251cf
commit d72a32d114
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
paper-api/README.md
View File

@ -1,6 +1,6 @@
Bukkit Bukkit
====== ======
A plugin API for [Minecraft](https://minecraft.net/) servers, currently maintained by [SpigotMC](http://www.spigotmc.org/). A plugin API for [Minecraft](https://minecraft.net/) servers, currently maintained by [SpigotMC](https://www.spigotmc.org/).
#### Index #### Index
* [Bug Reporting](#bug-reporting) * [Bug Reporting](#bug-reporting)
@ -11,11 +11,13 @@ A plugin API for [Minecraft](https://minecraft.net/) servers, currently maintain
Bug Reporting 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/). <a name="bug-reporting"></a>
The development team is very open to both bug and feature requests / suggestions. You can submit these on the [JIRA Issue Tracker](https://hub.spigotmc.org/jira/).
Compilation Compilation
----------- -----------
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: <a name="compilation"></a>
Bukkit is a Java program which uses [Maven 3](https://maven.apache.org/) for compilation. To compile fresh from Git, simply perform the following steps:
* Install Maven and Git using your preferred installation methods. * Install Maven and Git using your preferred installation methods.
* `git clone https://hub.spigotmc.org/stash/scm/spigot/bukkit.git`. * `git clone https://hub.spigotmc.org/stash/scm/spigot/bukkit.git`.
@ -25,10 +27,11 @@ Some IDEs such as [NetBeans](https://netbeans.org/) can perform these steps for
Contributing Contributing
------------ ------------
<a name="contributing"></a>
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: 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:
* Create an account on [JIRA](http://hub.spigotmc.org/jira/). * Create an account on [JIRA](https://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. * Fill in the [SpigotMC CLA](https://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. * 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. Once you have performed these steps you can create a fork, push your code changes, and then submit it for review.
@ -39,9 +42,10 @@ Although the minimum requirement for compilation & usage is Java 8, we prefer al
Bukkit's Goals Bukkit's Goals
-------------- --------------
<a name="bukkits-goals"></a>
As a rough guideline, ask yourself the following questions to determine if the proposed change fits the Bukkit project's goals. Please remember that this is only a rough guideline As a rough guideline, ask yourself the following questions to determine if the proposed change fits the Bukkit project's goals. Please remember that this is only a rough guideline
and it may or may not reflect the definitive answer to this question. and it may or may not reflect the definitive answer to this question.
Discussions about proposed changes are held in the [Spigot IRC](https://www.spigotmc.org/wiki/irc-guide/). Discussions about proposed changes are held in the [Spigot Discord](https://www.spigotmc.org/go/discord).
* Does it expose an implementation detail of the server software, or the protocol or file formats? * Does it expose an implementation detail of the server software, or the protocol or file formats?
@ -63,7 +67,8 @@ Regardless, there are a few other important questions that need to be asked befo
Code Requirements Code Requirements
----------------- -----------------
* For the most part, CraftBukkit and Bukkit use the [Sun/Oracle coding standards](http://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc-136057.html). <a name="code-requirements"></a>
* For the most part, CraftBukkit and Bukkit use the [Sun/Oracle coding standards](https://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc-136057.html).
* No tabs; use 4 spaces instead. * No tabs; use 4 spaces instead.
* Empty lines should contain no spaces. * Empty lines should contain no spaces.
* No trailing whitespaces. * No trailing whitespaces.
@ -79,7 +84,7 @@ Code Requirements
* Avoid moving or renaming classes. * Avoid moving or renaming classes.
* All non-private methods and constructors must have specified nullability through [annotations](https://github.com/JetBrains/java-annotations) * All non-private methods and constructors must have specified nullability through [annotations](https://github.com/JetBrains/java-annotations)
Bukkit/CraftBukkit employs [JUnit 4](http://www.vogella.com/articles/JUnit/article.html) for testing. Pull Requests(PR) should attempt to integrate within that framework as appropriate. Bukkit/CraftBukkit employs [JUnit 4](https://www.vogella.com/tutorials/JUnit4/article.html) for testing. Pull Requests(PR) should attempt to integrate within that framework as appropriate.
Bukkit is a large project and what seems simple to a PR author at the time of writing may easily be overlooked by other authors and updates. Including unit tests with your PR Bukkit is a large project and what seems simple to a PR author at the time of writing may easily be overlooked by other authors and updates. Including unit tests with your PR
will help to ensure the PR can be easily maintained over time and encourage the Spigot team to pull the PR. will help to ensure the PR can be easily maintained over time and encourage the Spigot team to pull the PR.
@ -88,4 +93,4 @@ will help to ensure the PR can be easily maintained over time and encourage the
* Do not group packages * Do not group packages
* __Absolutely no wildcard imports outside of tests.__ * __Absolutely no wildcard imports outside of tests.__
Any questions about these requirements can be asked in #spigot-dev in IRC. Any questions about these requirements can be asked in #help-development in Discord.