diff --git a/README.md b/README.md index f81202e0c3cd1a54cefcf4b112a7778bb4ddb8f2..04b34cbc07c98e73740b13200ed83fe067af99d2 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 30e53ac1c65763fb52b711a215f682c01d2e570e..9da548395073643c16539cef180c4d6412dd8d46 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`.