MiniDay/Velocity
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

Note code style.

Browse Source
This commit is contained in:
Andrew Steinborn
2018-10-28 01:34:24 -04:00
parent 65ff9ebb39
commit d7aebfdc20
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@@ -19,9 +19,9 @@ and the [Checker Framework annotations](https://checkerframework.org/)).
While you can certainly work with the Velocity codebase without knowing any While you can certainly work with the Velocity codebase without knowing any
of this, it can be risky to proceed. of this, it can be risky to proceed.
Velocity does not currently obey any one general code style at the moment. Velocity tries to follow the [Google Code Style](https://google.github.io/styleguide/javaguide.html)
Plans are [in the works](https://github.com/VelocityPowered/Velocity/issues/125) for Java. As we have recently switched, some minor style issues currently
to define the code style the project will follow. remain, which will be fixed over time.
# Notes on the build # Notes on the build
@@ -31,5 +31,5 @@ and pull requests:
* [Checker Framework](https://checkerframework.org/): an enhancement to Java's type * [Checker Framework](https://checkerframework.org/): an enhancement to Java's type
system that is designed to help catch bugs. Velocity runs the _Nullness Checker_ system that is designed to help catch bugs. Velocity runs the _Nullness Checker_
and the _Optional Checker_. and the _Optional Checker_.
* [Checkstyle](http://checkstyle.sourceforge.net/) (not currently in use): ensures * [Checkstyle](http://checkstyle.sourceforge.net/): ensures that your code is
that your code is correctly formatted. correctly formatted.