Mention naming convention in CONTRIBUTING.adoc (#809 / #812) #812
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The naming convention for classes and methods was not yet mentioned in our contributing guideline.
Bukama
changed the title
Michael1993
reviewed
Apr 20, 2024
CONTRIBUTING.adoc
Outdated
| ==== 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). |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The naming convention for classes and methods was not yet mentioned in our contributing guideline.
closes: #809
PR: #812