From 5b885776beba79ef34d68465293ef91c5fe3c103 Mon Sep 17 00:00:00 2001 From: Daniel Hornung <d.hornung@indiscale.com> Date: Mon, 21 Jun 2021 13:29:27 +0200 Subject: [PATCH] DOC: Code style for contrbutors. --- README.md | 16 ++++++++++------ README_SETUP.md | 4 ---- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f81202e0..04b34cbc 100644 --- a/README.md +++ b/README.md @@ -28,14 +28,18 @@ By participating, you are expected to uphold our [Code of Conduct](https://gitla * You found a bug, have a question, or want to request a feature? Please [create an issue](https://gitlab.com/caosdb/caosdb-pylib/-/issues). -* You want to contribute code? Please fork the repository and create a merge -request in GitLab and choose this repository as target. Make sure to select -"Allow commits from members who can merge the target branch" under Contribution -when creating the merge request. This allows our team to work with you on your request. -- If you have a suggestion for the [documentation](https://docs.indiscale.com/caosdb-pylib/), +* You want to contribute code? + * **Forking:** Please fork the repository and create a merge request in GitLab and choose this repository as + target. Make sure to select "Allow commits from members who can merge the target branch" under + Contribution when creating the merge request. This allows our team to work with you on your + request. + * **Code style:** This project adhers to the PEP8 recommendations, you can test your code style + using the `autopep8` tool (`autopep8 -i -r ./`). Please write your doc strings following the + [NumpyDoc](https://numpydoc.readthedocs.io/en/latest/format.html) conventions. +* If you have a suggestion for the [documentation](https://docs.indiscale.com/caosdb-pylib/), the preferred way is also a merge request as describe above (the documentation resides in `src/doc`). However, you can also create an issue for it. -- You can also contact us at **info (AT) caosdb.de** and join the +* You can also contact us at **info (AT) caosdb.de** and join the CaosDB community on [#caosdb:matrix.org](https://matrix.to/#/!unwwlTfOznjEnMMXxf:matrix.org). diff --git a/README_SETUP.md b/README_SETUP.md index 30e53ac1..9da54839 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -143,10 +143,6 @@ Now would be a good time to continue with the [tutorials](tutorials/index). ## Run Unit Tests tox -## Code Formatting - -autopep8 -i -r ./ - ## Documentation ## Build documentation in `build/` with `make doc`. -- GitLab