From c99ea8de061a1b9b1d91ceae621523ea9d1c869e Mon Sep 17 00:00:00 2001 From: KennyTV Date: Sun, 30 Aug 2020 15:18:13 +0200 Subject: [PATCH] Add simple contribution guidelines --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..051a5430 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +## Contributing to Hangar + +Take a look at the [README building section](README.md#Building) for info on how to set up the project.\ +A general list of todos can be found in the [Roadmap Project](https://github.com/PaperMC/Hangar/projects/1). + +## General Policy +Don't make the code look like it comes from a one-time contributor, +but embed it sanely into the surrounding code. +Changes should be easy to maintain and understand (with telling names and comments), +and when in doubt, ask other contributors if your idea makes sense/nobody else is working on it already. + +## Formatting +Nothing crazy here: +* Use 4 spaces (not tabs) as indention +* Leave an empty line between class headers and their first field +* Always use braces for single line ifs, for loops, etc. + +Other than that, we follow [Oracle's standard code conventions](https://www.oracle.com/java/technologies/javase/codeconventions-contents.html) (e.g. IntelliJ's auto formatting). \ No newline at end of file