From 3fde92aa95f1f545214ae5af69d87e551e2baae3 Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Fri, 1 Sep 2023 12:59:40 +0200
Subject: [PATCH] DOC: Better documentation hints in MR template.
---
.gitlab/merge_request_templates/Default.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md
index 3629e0ca..1fd7ab3d 100644
--- a/.gitlab/merge_request_templates/Default.md
+++ b/.gitlab/merge_request_templates/Default.md
@@ -28,6 +28,7 @@ guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md)
- [ ] 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`).
- 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.
@@ -42,7 +43,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), also in published
+- [ ] Appropriate user and developer documentation (or not necessary), also in published, also in published
+ documentation.
documentation.
- [ ] The test environment setup works and the intended behavior is reproducible in the test
environment
--
GitLab