Skip to content

Commit

Permalink
update Coding-conventions.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AdamZsofi authored Nov 11, 2024
1 parent 562d9cb commit b0c2a20
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/Coding-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

We mainly follow the standard Java coding conventions and most of the conventions from the books _Effective Java_ [1] and _Clean Code_ [4]. Some exceptions and additional rules are listed below. Each rule starts with _DO_, _CONSIDER_, _AVOID_ or _DO NOT_, according to [2].

## Automatic Formatting and Copyright Headers

See [Build.md](Build.md). For the formatting rules, check [java-common.gradle.kts](https://github.com/ftsrg/theta/blob/master/buildSrc/src/main/kotlin/java-common.gradle.kts)

## Source files
* **DO** encode files in UTF-8. **DO NOT** use any other format.

Expand Down

0 comments on commit b0c2a20

Please sign in to comment.