Skip to content

Commit

Permalink
Mention naming convention in CONTRIBUTING.adoc (#809 / NA)
Browse files Browse the repository at this point in the history
The naming convention for classes and methods was not yet mentioned in our contributing guideline.
  • Loading branch information
Bukama committed Apr 20, 2024
1 parent 6ecdc91 commit 244b8f7
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,12 @@ Everything related to branches, commits, and more is described #fixing-bugs-deve

Where to put types and how to name them.

==== Naming Convention

If not explicit mentioned differently, we follow the https://en.wikipedia.org/wiki/Camel_case[`camelCase`] convention for naming classes and methods.
This means that everything is written without spaces, but every word starts with an upper letter, e.g. `DisableIfTestFailsExtension` (class name) or `handleTestExecutionException` (method name).


==== Package Structure

Classes usually belong into one of these packages:
Expand Down

0 comments on commit 244b8f7

Please sign in to comment.