diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md index 7859b7be21fb1c3eda91ee35173a8e3412a62066..3629e0ca3695000863d8c254516f64bf59a7bf60 100644 --- a/.gitlab/merge_request_templates/Default.md +++ b/.gitlab/merge_request_templates/Default.md @@ -26,7 +26,9 @@ guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md) - [ ] All automated tests pass - [ ] Reference related issues - [ ] Up-to-date CHANGELOG.md (or not necessary) +- [ ] Up-to-date JSON schema (or not necessary) - [ ] Appropriate user and developer documentation (or not necessary) + - Update / write published documentation (`make doc`). - How do I use the software? Assume "stupid" users. - How do I develop or debug the software? Assume novice developers. - [ ] Annotations in code (Gitlab comments) @@ -40,7 +42,8 @@ guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md) - [ ] I understand the intent of this MR - [ ] All automated tests pass - [ ] Up-to-date CHANGELOG.md (or not necessary) -- [ ] Appropriate user and developer documentation (or not necessary) +- [ ] Appropriate user and developer documentation (or not necessary), also in published + documentation. - [ ] The test environment setup works and the intended behavior is reproducible in the test environment - [ ] In-code documentation and comments are up-to-date. diff --git a/README.md b/README.md index 10bf86697455b8258a7b7020066b49f91e6132f1..5377f59a9dee29228e1777eaeac316aa203dc9dd 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ setup this code. Please refer to the [official documentation](https://docs.indiscale.com/caosdb-octavelib/) for more information. -ibuting +## Contributing Thank you very much to all contributers—[past, present](https://gitlab.com/linkahead/linkahead/-/blob/main/HUMANS.md), and prospective @@ -31,10 +31,10 @@ Conduct](https://gitlab.com/linkahead/linkahead/-/blob/main/CODE_OF_CONDUCT.md). * You found a bug, have a question, or want to request a feature? Please [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. + * **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. diff --git a/RELEASE_GUIDELINES.md b/RELEASE_GUIDELINES.md index c73c765d236106b48fc4288d6a00be0c9fb2d64c..110e928558d7c0f2cf458037573ed0b35e9faffb 100644 --- a/RELEASE_GUIDELINES.md +++ b/RELEASE_GUIDELINES.md @@ -66,10 +66,18 @@ See [full changelog](https://gitlab.indiscale.com/caosdb/src/caosdb-octavelib/-/ These steps are necessary for creating the upstream package at Octave's repository: 1. Update Octave-package repository on github.com: - 1. In `packages/caosdb.yaml`, create new version release: - 1. Set `id`: same as tag - 2. Set `date`: today - 3. Set `url`: Use the asset from the Gitlab release, for example [this url](https://gitlab.indiscale.com/caosdb/src/caosdb-octavelib/-/archive/v0.0.1/caosdb-octavelib-v0.0.1.tar.gz). - 4. Set `sha256`: Download the asset and run `sha256` on it: - `curl https://gitlab.indiscale.com/[...].tar.bz2 | sha256sum` - 2. Create pull request at https://github.com/gnu-octave/packages . + 1. In `packages/caosdb.yaml`, create new version release: + 1. Set `id`: same as tag + 2. Set `date`: today + 3. Set `url`: Use the asset from the Gitlab release, for example [this url](https://gitlab.indiscale.com/caosdb/src/caosdb-octavelib/-/archive/v0.0.1/caosdb-octavelib-v0.0.1.tar.gz). + 4. Set `sha256`: Download the asset and run `sha256` on it: + `curl https://gitlab.indiscale.com/[...].tar.bz2 | sha256sum` + 2. Commit with commit message "Package release CaosDB-octavelib 0.2.1" + 3. Create pull request at https://github.com/gnu-octave/packages and accept it: + - Assign to myself. + - Set label `package release`. + - Ignore failing test `check-package` if the error is: + ``` + [EE] The build tool `conan' seems to be missing. + ``` + - Merge pull request. diff --git a/doc/index.rst b/doc/index.rst index 8ce2d942c48dd62a9bd14c98c7f142cef19e620d..9a4668bde0fb98beabb6ee45996a0db0e9f84595 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -22,10 +22,10 @@ .. _welcome: -Welcome to caosdb-octavelib's documentation! +Welcome to LinkAhead-octavelib's documentation! ============================================ -This is the documentation for the GNU Octave client library for CaosDB, ``caosdb-octavelib``. +This is the documentation for the GNU Octave client library for LinkAhead, ``caosdb-octavelib``. Note that most of the documentation is in Octave's native format. @@ -37,5 +37,6 @@ Note that most of the documentation is in Octave's native format. Welcome <self> Development Package documentation <api> + Back to Overview <https://docs.indiscale.com/> * :ref:`genindex`