Mirror von
https://github.com/PaperMC/Velocity.git
synchronisiert 2024-12-26 16:12:50 +01:00
35 Zeilen
1.5 KiB
Markdown
35 Zeilen
1.5 KiB
Markdown
Thanks for taking the time to submit a contribution to Velocity! Your support
|
|
is greatly appreciated.
|
|
|
|
In this document, we'll give you some tips on making it more likely your
|
|
contribution will be pulled.
|
|
|
|
# Setting up a development environment
|
|
|
|
This isn't as difficult as you may be led to believe. All you need to do is
|
|
clone the Velocity repository in your favorite IDE and have your backend test
|
|
servers set up to run behind Velocity.
|
|
|
|
# Actually working on the code
|
|
|
|
It is strongly recommended that you are familiar with the Minecraft protocol,
|
|
proficient with using Java, and have familiarity with the libraries used in
|
|
Velocity (particularly [Netty](https://netty.io), [Google Guava](https://github.com/google/guava),
|
|
and the [Checker Framework annotations](https://checkerframework.org/)).
|
|
While you can certainly work with the Velocity codebase without knowing any
|
|
of this, it can be risky to proceed.
|
|
|
|
Velocity follows the [Google Code Style](https://google.github.io/styleguide/javaguide.html)
|
|
for Java. Velocity will not build if any Checkstyle issues are found, so make
|
|
sure that you are properly adhering to the code style.
|
|
|
|
# Notes on the build
|
|
|
|
To reduce bugs and ensure code quality, we run the following tools on all commits
|
|
and pull requests:
|
|
|
|
* [SpotBugs](https://spotbugs.github.io/): ensures that common errors do not
|
|
get into the codebase. The build will fail if SpotBugs finds an issue.
|
|
* [Checkstyle](http://checkstyle.sourceforge.net/): ensures that your code is
|
|
correctly formatted. The build will fail if Checkstyle detects a problem.
|