Skip to content

Add code formatting documentation #183

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

Open
wborn wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add code formatting documentation #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43fa876
Add Code formatting documentation
wborn Jul 31, 2026
d47317d
Add links to code formatting docs
wborn Jul 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/20-quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ We follow the [GitHub Flow](https://docs.github.com/en/get-started/quickstart/gi

When your changes are complete then create a Pull Request ensuring that your branch is up-to-date with the source branch and that code changes are covered by tests and that the full test suite passes.

Before opening the pull request, [check and apply the repository's code-formatting rules](./developer-guide/025-code-formatting.md).

## Discuss OpenRemote

Join us on the [community forum](https://forum.openremote.io/).
2 changes: 2 additions & 0 deletions docs/developer-guide/020-setting-up-an-ide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ You can download the [IntelliJ Community Edition](https://www.jetbrains.com/idea
- [Grep Console](https://plugins.jetbrains.com/plugin/7125-grep-console)
- [Markdown Navigator](https://plugins.jetbrains.com/plugin/7896-markdown-navigator)

For formatter plugins and IDE settings, see [Code formatting with Spotless](./025-code-formatting.md#intellij-idea).

##### Grep Console Styling

The log messages of the running application can be colour-highlighted with the [GrepConsole plugin](https://plugins.jetbrains.com/plugin/7125-grep-console) and our [configuration](https://github.com/openremote/openremote/tree/master/tools/intellij).
Expand Down
Loading