Skip to content

Commit

Permalink
[docs] Cover naming of Channel ID (#1492)
Browse files Browse the repository at this point in the history
Make the Java naming convention more clear, as 100% of the new binding submissions that I have looked in the last week have all failed to know this. In most cases it is the Channel ID that they get wrong as:

1. Some merged bindings do it "differently".
2. The linked url does not cover what to do for channel IDs.

Signed-off-by: Matthew Skinner <[email protected]>
  • Loading branch information
Skinah authored Feb 16, 2021
1 parent 74313e0 commit 29eb9cf
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion developers/guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,10 @@ The rules are defined at <https://github.com/openhab/static-code-analysis/tree/m

### Java Coding Style

- The [Java naming conventions](https://java.about.com/od/javasyntax/a/nameconventions.htm) should be used for source files.
- The [Java naming conventions](https://java.about.com/od/javasyntax/a/nameconventions.htm) should always be used and are descibed in detail at the link, a quick summary is:
* Channel IDs: `lowerCamelCase`
* Variables: `lowerCamelCase`
* Constants: `ALL_UPPER_CASE`
- Generics must be used where applicable. See example below:

```java
Expand Down

0 comments on commit 29eb9cf

Please sign in to comment.