From e01a90b7529030cc2f622c18345c968e774954b0 Mon Sep 17 00:00:00 2001 From: Tom Morrell Date: Wed, 18 Sep 2024 15:35:04 -0700 Subject: [PATCH 1/3] github: customize pull request template for documentation --- .github/.github/pull_request_template.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/.github/pull_request_template.md diff --git a/.github/.github/pull_request_template.md b/.github/.github/pull_request_template.md new file mode 100644 index 00000000..7cf40440 --- /dev/null +++ b/.github/.github/pull_request_template.md @@ -0,0 +1,23 @@ +:heart: Thank you for your contribution! + +### Description + +> Please describe briefly your pull request. + + + +### Checklist + +Ticks in all boxes and 🟢 on all GitHub actions status checks are required to merge: + +- [ ] I'm aware of the [code of conduct](https://inveniordm.docs.cern.ch/contribute/code-of-conduct/). +- [ ] I've created [logical separate commits](https://inveniordm.docs.cern.ch/develop/best-practices/commits/#commits) and followed the [commit message format](https://inveniordm.docs.cern.ch/develop/best-practices/commits/#commit-message). +- [ ] I've targeted the `master` branch. +- [ ] If this documentation upgrade impacts the current release, I will backport it to the `production` branch following approval. + +**Reminder** + +By using GitHub, you have already agreed to the [GitHub’s Terms of Service](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) including that: + +1. You license your contribution under the same terms as the current repository’s license. +2. You agree that you have the right to license your contribution under the current repository’s license. From b55be80115366e83915385136304dcabc07283eb Mon Sep 17 00:00:00 2001 From: Tom Morrell Date: Mon, 23 Sep 2024 08:15:49 -0700 Subject: [PATCH 2/3] Update pull_request_template.md --- .github/.github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/.github/pull_request_template.md b/.github/.github/pull_request_template.md index 7cf40440..dcd2b9f2 100644 --- a/.github/.github/pull_request_template.md +++ b/.github/.github/pull_request_template.md @@ -13,7 +13,7 @@ Ticks in all boxes and 🟢 on all GitHub actions status checks are required to - [ ] I'm aware of the [code of conduct](https://inveniordm.docs.cern.ch/contribute/code-of-conduct/). - [ ] I've created [logical separate commits](https://inveniordm.docs.cern.ch/develop/best-practices/commits/#commits) and followed the [commit message format](https://inveniordm.docs.cern.ch/develop/best-practices/commits/#commit-message). - [ ] I've targeted the `master` branch. -- [ ] If this documentation upgrade impacts the current release, I will backport it to the `production` branch following approval. +- [ ] If this documentation change impacts the current release of InvenioRDM, I will backport it to the `production` branch following approval or indicate to a maintainer that it should be backported. **Reminder** From 94010e48bdb9b2def3df72ae70dc4cd6a28b4056 Mon Sep 17 00:00:00 2001 From: Tom Morrell Date: Mon, 23 Sep 2024 08:18:29 -0700 Subject: [PATCH 3/3] readme: add links and branches --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 32353a85..1d8abdb6 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## About -InvenioRDM user documentation web site. +This is the source of InvenioRDM user documentation web site. You can view the documentation for the current release of InvenioRDM at [https://inveniordm.docs.cern.ch/]( https://inveniordm.docs.cern.ch/), which tracks the `production` branch of this repository. You can see the documentation for the in-development next version of InvenioRDM at [https://inveniordm-dev.docs.cern.ch/](https://inveniordm-dev.docs.cern.ch/), which tracks the `master` branch of this repository. ## Running