Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 1.53 KB
Raw

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, Google Guava, and the Checker Framework annotations). 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 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: ensures that common errors do not get into the codebase. The build will fail if SpotBugs finds an issue.
  • Checkstyle: ensures that your code is correctly formatted. The build will fail if Checkstyle detects a problem.