diff --git a/README.md b/README.md index a2284f2b9a6d92d4a1b51646d48b0a5d30fbc4bf..10bf86697455b8258a7b7020066b49f91e6132f1 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ ## Welcome -This is the **CaosDB Octave Client Library** repository and a part of the -CaosDB project. +This is the **LinkAhead Octave Client Library** repository and a part of the +LinkAhead project. ## Setup @@ -15,28 +15,31 @@ setup this code. Please refer to the [official documentation](https://docs.indiscale.com/caosdb-octavelib/) for more information. -## Contributing +ibuting -Thank you very much to all contributers — past, present, and prospective ones. +Thank you very much to all contributers—[past, +present](https://gitlab.com/linkahead/linkahead/-/blob/main/HUMANS.md), and prospective +ones. ### Code of Conduct -By participating, you are expected to uphold our [Code of Conduct](https://gitlab.com/caosdb/caosdb-octavelib/-/blob/dev/CODE_OF_CONDUCT.md). +By participating, you are expected to uphold our [Code of +Conduct](https://gitlab.com/linkahead/linkahead/-/blob/main/CODE_OF_CONDUCT.md). ### 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-octavelib/-/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-octavelib/), -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.org** and join the - CaosDB community on - [#caosdb:matrix.org](https://matrix.to/#/!unwwlTfOznjEnMMXxf:matrix.org). +[create an issue](https://gitlab.com/linkahead/linkahead-octavelib/-/issues). +* 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. +* You can also join the LinkAhead community on + [#linkahead:matrix.org](https://matrix.to/#/!unwwlTfOznjEnMMXxf:matrix.org). ## License