mirror/Hangar
2
0
Fork 0
mirror of https://github.com/HangarMC/Hangar.git synced 2024-11-21 01:21:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add simple contribution guidelines

Browse Source
This commit is contained in:
KennyTV 2020-08-30 15:18:13 +02:00
parent 4a027b58ae
commit c99ea8de06
No known key found for this signature in database
GPG Key ID: 6BE3B555EBC5982B
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.md Normal file
View File

@ -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).