From f6b547e20f4069222683046eba61919da358cf9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <henrik@trineo.org> Date: Mon, 1 Mar 2021 14:39:18 +0100 Subject: [PATCH] DOC: updated README.md --- README.md | 40 ++++++++++++++++++++++++++++++---------- 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2a11f69..835138c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ [](https://gitlab.com/caosdb/caosdb-pyinttest/commits/dev) -# Welcome +# README -This is the **CaosDB Python Integration Tests** repository and a part of the +## Welcome + +This is the **CaosDB Python Integration Testing** repository and a part of the CaosDB project. -# Getting started # +## Getting started # - To run tests, start up a CaosDB server with (documentation for this can be found elsewhere). - The CaosDB server must have debugging enabled. @@ -15,16 +17,34 @@ CaosDB project. - If you want to run just a single test, you can also select a single test file: `pytest-3 tests/test_issues.py` -# Further Reading -Please refer to the [official gitlab repository of the CaosDB -project](https://gitlab.com/caosdb/caosdb) for more information. +## Further Reading + +Please refer to the [official documentation](https://caosdb.gitlab.io/caosdb-pylib/) for more information. + +## Contributing + +Thank you very much to all contributers—[past, present](https://gitlab.com/caosdb/caosdb/-/blob/dev/HUMANS.md), and prospective ones. + +### Code of Conduct -# License +By participating, you are expected to uphold our [Code of Conduct](https://gitlab.com/caosdb/caosdb/-/blob/dev/CODE_OF_CONDUCT.md). -Copyright (C) 2018 Research Group Biomedical Physics, Max Planck Institute for -Dynamics and Self-Organization Göttingen. +### How to Contribute + +* You found a bug, have a question, or want to request a feature? Please +[create an issue](https://gitlab.com/caosdb/caosdb-pyinttest/-/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. +- You can also contact us at **info (AT) caosdb.de**. + +## License + +* Copyright (C) 2018 Research Group Biomedical Physics, Max Planck Institute + for Dynamics and Self-Organization Göttingen. +* Copyright (C) 2020-2021 Indiscale GmbH <info@indiscale.com> All files in this repository are licensed under a [GNU Affero General Public License](LICENCE.md) (version 3 or later). - -- GitLab