diff --git a/web/content/docs/devguide/development-workflows/code-format.md b/web/content/docs/devguide/development-workflows/code-format.md new file mode 100644 index 0000000000000000000000000000000000000000..ac4de63afede92ca80dcbeaec59faf759002ba95 --- /dev/null +++ b/web/content/docs/devguide/development-workflows/code-format.md @@ -0,0 +1,36 @@ ++++ +date = "2018-02-26T11:00:13+01:00" +title = "Code style and formatting" +author = "Lars Bilke" +weight = 1012 + +[menu] + [menu.devguide] + parent = "development-workflows" ++++ + +We aim for a consistent and readable coding style. You do not need to worry about styling if you use the right tools we present in the following. + +## C++ + +Use [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html). Can be added to be automatically run on save in your editor / IDE: + +- [Vim](https://github.com/rhysd/vim-clang-format) +- [Visual Studio](https://devblogs.microsoft.com/cppblog/clangformat-support-in-visual-studio-2017-15-7-preview-1/) +- [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=xaver.clang-format) + +Current style is defined in [.clang-format](https://gitlab.opengeosys.org/ogs/ogs/-/blob/master/.clang-format). + +## Python + +Use [`black`](https://black.readthedocs.io/en/stable/). Can be added to be automatically run on save in your editor / IDE: + +- [Vim](https://black.readthedocs.io/en/stable/editor_integration.html#vim) +- [PyCharm](https://black.readthedocs.io/en/stable/editor_integration.html#pycharm-intellij-idea) +- [Visual Studio Code](https://code.visualstudio.com/docs/python/editing#_formatting) + +`black` is also run by our `pre-commit`-hooks. To run manually: + +```bash +pre-commit run black --all-files +``` diff --git a/web/content/docs/devguide/development-workflows/code-reviews.md b/web/content/docs/devguide/development-workflows/code-reviews.md index fe4a05ba2d5fbe734c0b05dd805155b04ed0e9d8..50d1f450ea902e0c6795b7ae8eefac837f3a1826 100644 --- a/web/content/docs/devguide/development-workflows/code-reviews.md +++ b/web/content/docs/devguide/development-workflows/code-reviews.md @@ -2,7 +2,7 @@ date = "2018-02-26T11:00:13+01:00" title = "Code Reviews" author = "Lars Bilke" -weight = 1012 +weight = 1014 [menu] [menu.devguide] diff --git a/web/content/docs/devguide/development-workflows/continuous-integration.md b/web/content/docs/devguide/development-workflows/continuous-integration.md index 23685ef2f794eedeca3913abe1fc05b670dac1f4..c632c6b7afb0e124667682aa4a1d18418077e528 100644 --- a/web/content/docs/devguide/development-workflows/continuous-integration.md +++ b/web/content/docs/devguide/development-workflows/continuous-integration.md @@ -2,7 +2,7 @@ date = "2018-02-26T11:00:13+01:00" title = "Continuous Integration" author = "Lars Bilke" -weight = 1013 +weight = 1016 [menu] [menu.devguide] diff --git a/web/content/docs/devguide/development-workflows/development-ides.md b/web/content/docs/devguide/development-workflows/development-ides.md index f9538c68be3016fcbecb7ee682b79e0b108f9baa..e3cd06bb94c0722452cbe16472c1e96786d2fedf 100644 --- a/web/content/docs/devguide/development-workflows/development-ides.md +++ b/web/content/docs/devguide/development-workflows/development-ides.md @@ -2,7 +2,7 @@ date = "2018-02-26T11:00:13+01:00" title = "Development IDEs" author = "Marc Walther" -weight = 1014 +weight = 1013 [menu] [menu.devguide]