Skip to content

Commit

Permalink
ci: copy file
Browse files Browse the repository at this point in the history
  • Loading branch information
sujuka99 committed Oct 25, 2023
1 parent 12616c0 commit 033ccad
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 4 deletions.
1 change: 0 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
43 changes: 43 additions & 0 deletions docs/docs/developer/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<!-- This file is autogenerated by /home/sujuka99/Projects/bakdata/kpops/hooks/gen_docs/gen_docs_contributing.py. -->

# 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)
4 changes: 1 addition & 3 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 033ccad

Please sign in to comment.