diff --git a/.github/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/normal.md similarity index 96% rename from .github/pull_request_template.md rename to .github/PULL_REQUEST_TEMPLATE/normal.md index 3574c3599..f43d39706 100644 --- a/.github/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/normal.md @@ -1,18 +1,18 @@ -## :bookmark_tabs: Summary - -Brief description about the content of your PR. - -Resolves # - -## :straight_ruler: Design Decisions - -Describe the way your implementation works or what design decisions you made if applicable. - -### :clipboard: Tasks - -Make sure you - -- [ ] :book: have read the [contribution guidelines](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md) -- [ ] :computer: have added unit/e2e tests (if appropriate) -- [ ] :notebook: have added documentation (if appropriate) -- [ ] :bookmark: targeted `develop` branch +## :bookmark_tabs: Summary + +Brief description about the content of your PR. + +Resolves # + +## :straight_ruler: Design Decisions + +Describe the way your implementation works or what design decisions you made if applicable. + +### :clipboard: Tasks + +Make sure you + +- [ ] :book: have read the [contribution guidelines](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md) +- [ ] :computer: have added unit/e2e tests (if appropriate) +- [ ] :notebook: have added documentation (if appropriate) +- [ ] :bookmark: targeted `develop` branch diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md new file mode 100644 index 000000000..737a9677c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -0,0 +1,19 @@ +# Release vX.X.X + +## Release checklist + + - [ ] Forked from `develop` branch + - [ ] Draft PR created, targeting `master` branch + - [ ] Ready for review + - [ ] Ready for testing + - [ ] Tested by - + - [ ] Ready for merge + +## Release process + +- The PR is marked as `Ready for review` by the author +- The PR is reviewed by at least one other person +- The PR is marked as `Ready for testing` by the reviewer once the review and necessary changes are complete +- The PR is tested by the someone other than the author +- The PR is marked as `Tested by - @testerName` by the tester once the testing is complete +- The PR is marked as `Ready for merge` by the author once the testing is complete and CI is green.