diff --git a/README.md b/README.md index 3fadc0c69386b1db306dec85cfc4c3a5550c00f2..f59bfbdcb84f07fafdaef4a324fe18a9a1f1fbba 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@ status](https://gitlab.indiscale.com/caosdb/src/caosdb-julialib/badges/main/pipe ## Welcome -This is the development repository of **caosdb-julialib** - a Julia -client library for CaosDB and a part of the CaosDB project. +This is the development repository of **LinkAhead Julia Client Library** - a +client library for LinkAhead and a part of the LinkAhead project. ## Setup @@ -25,7 +25,29 @@ information. ## Contributing -Please read [CONTRIBUTING.md](CONTRIBUTING.md). +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/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/linkahead/linkahead-julialib/-/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