diff --git a/.github/.github/pull_request_template.md b/.github/.github/pull_request_template.md new file mode 100644 index 00000000..dcd2b9f2 --- /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 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** + +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. 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