Skip to content

Commit

Permalink
Fix contributing example
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexProgrammerDE committed Feb 19, 2024
1 parent a62335e commit d56a802
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@ Thank you for considering to contribute to SoulFire! Please read the following p
## Code style

This project uses the google-java-format loosely. While most recommended options are enforced, some others are not.
As a rule of thumb, if your IDE would spit the same code out with the "Reformat" task, it should be fine.
As a rule of thumb, if your IDE spits the same code out with the "Reformat" task, it should be fine.

To setup the google java format, please read the official page and follow the instructions for your IDE:
https://github.com/google/google-java-format

### Var keyword

SoulFire exclusively uses the var keyword instead of explicitly declaring field types.
That also includes types like `Map<String> map = new HashMap<>()`, those should be abbreviated to `var map = new HashMap<String>()`
That also includes types like `Map<String, String> map = new HashMap<>()`,
those should be abbreviated to `var map = new HashMap<String, String>()`

### IntelliJ inspections

Expand Down

0 comments on commit d56a802

Please sign in to comment.