From 033ccad115d74f37dfcc93ee7a1aa9517a2a6b7e Mon Sep 17 00:00:00 2001 From: Ivan Yordanov Date: Wed, 25 Oct 2023 20:56:14 +0300 Subject: [PATCH] ci: copy file --- CONTRIBUTING.md | 1 - docs/docs/developer/contributing.md | 43 +++++++++++++++++++++++++++++ docs/mkdocs.yml | 4 +-- 3 files changed, 44 insertions(+), 4 deletions(-) create mode 100644 docs/docs/developer/contributing.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 236dcf60b..fb6d8e23d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,6 @@ If you find any bugs or have suggestions for improvements, please open an [issue](https://github.com/bakdata/kpops/issues/new) and optionally a [pull request (PR)](https://github.com/bakdata/kpops/compare). In the case of a PR, we would appreciate it if you preface it with an issue outlining your goal and means of achieving it. - ## Style We advise that you stick to our `pre-commit` hooks, which you can run with `poetry run pre-commit run -a`. In order for `dprint` to work, you have to manually [install](#markdown) it locally. It will work in the CI, so it is also possible to manually carry out formatting changes flagged by `dprint` in the CI and skip installing it locally. diff --git a/docs/docs/developer/contributing.md b/docs/docs/developer/contributing.md new file mode 100644 index 000000000..282daba58 --- /dev/null +++ b/docs/docs/developer/contributing.md @@ -0,0 +1,43 @@ + + +# Contributions + +**Welcome!** We are glad to have you visit our contributibg guide! + +If you find any bugs or have suggestions for improvements, please open an [issue](https://github.com/bakdata/kpops/issues/new) and optionally a [pull request (PR)](https://github.com/bakdata/kpops/compare). In the case of a PR, we would appreciate it if you preface it with an issue outlining your goal and means of achieving it. + +## Style + +We advise that you stick to our `pre-commit` hooks, which you can run with `poetry run pre-commit run -a`. In order for `dprint` to work, you have to manually [install](#markdown) it locally. It will work in the CI, so it is also possible to manually carry out formatting changes flagged by `dprint` in the CI and skip installing it locally. + +### Python + +To ensure a consistent Python code style, we use [Ruff](https://docs.astral.sh/ruff/) for both linting and formatting. + +**Configuration** + +Our configuration can be found in [KPOps](https://github.com/bakdata/kpops)' top-level `pyproject.toml`. + +**Editor integration** + +Below are listed existing Ruff plugins/extensions for some of the most popular python IDEs. + +- [VSCode](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) +- [JetBrains](https://plugins.jetbrains.com/plugin/20574-ruff) + +If you cannot find your Editor of choices or you want something more custom, [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) enables Ruff to be used in any editor that supports the LSP + +### Markdown + +To ensure a consistent markdown style, we use [dprint](https://dprint.dev) to check and reformat. + +**Configuration** + +Our configuration can be found [here](https://github.com/bakdata/kpops/blob/main/dprint.json). + +**Editor integration** + +Below are listed existing `dprint` plugins/extensions for some of the most popular python IDEs. + +- [VSCode](https://marketplace.visualstudio.com/items?itemName=dprint.dprint) +- [JetBrains](https://plugins.jetbrains.com/plugin/18192-dprint) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index c4dec620b..9fd22d8a1 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -113,8 +113,6 @@ nav: - GitHub Actions: user/references/ci-integration/github-actions.md - Developer Guide: - Getting Started: developer/getting-started.md - - Style: - - Python: developer/style/python.md - - Markdown: developer/style/markdown.md + - Contributing: developer/contributing.md - Code base: - Auto generation: developer/auto-generation.md