Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mention naming convention in CONTRIBUTING.adoc (#809 / #812) #812

Merged
merged 2 commits into from
Apr 24, 2024
Merged

Mention naming convention in CONTRIBUTING.adoc (#809 / #812) #812

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
244b8f7
Mention naming convention in CONTRIBUTING.adoc (#809 / NA)
Bukama Apr 20, 2024
98b950a
Change link to Java naming conventions
Bukama Apr 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions CONTRIBUTING.adoc
View file
Open in desktop
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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not really the case. We follow the commonly accepted Java naming conventions which include SCREAMING_SNAKE_CASE (lol) for constants.
Maybe link to this instead: https://www.oracle.com/java/technologies/javase/codeconventions-namingconventions.html?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well :p. You are arguing with the naming of constants, while the text clearly is written about

convention for naming classes and methods.

And the Java naming conventions also say camelCase :D

Class names should be nouns, in mixed case with the first letter of each internal word capitalized

But yeah you are right, the Java code conventions would be the correct source. Will update it later.



==== Package Structure

Classes usually belong into one of these packages:
Expand Down