From d7aebfdc20b9f5bf75021b175f84571b938aaec5 Mon Sep 17 00:00:00 2001 From: Andrew Steinborn Date: Sun, 28 Oct 2018 01:34:24 -0400 Subject: [PATCH] Note code style. --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f104d0146..c902cc130 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,9 +19,9 @@ 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 does not currently obey any one general code style at the moment. -Plans are [in the works](https://github.com/VelocityPowered/Velocity/issues/125) -to define the code style the project will follow. +Velocity tries to follow the [Google Code Style](https://google.github.io/styleguide/javaguide.html) +for Java. As we have recently switched, some minor style issues currently +remain, which will be fixed over time. # Notes on the build @@ -31,5 +31,5 @@ and pull requests: * [Checker Framework](https://checkerframework.org/): an enhancement to Java's type system that is designed to help catch bugs. Velocity runs the _Nullness Checker_ and the _Optional Checker_. -* [Checkstyle](http://checkstyle.sourceforge.net/) (not currently in use): ensures - that your code is correctly formatted. \ No newline at end of file +* [Checkstyle](http://checkstyle.sourceforge.net/): ensures that your code is + correctly formatted. \ No newline at end of file