From e2daad36e99ddc7ac257385294d0491d0de2f660 Mon Sep 17 00:00:00 2001 From: Alan Rynne Date: Mon, 5 Oct 2020 16:58:20 +0200 Subject: [PATCH] feat: added PR template Updated docs to reflect it. --- .github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md | 25 ++++++++++++++++++++ README.md | 1 + 2 files changed, 26 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md new file mode 100644 index 0000000..c1701e0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md @@ -0,0 +1,25 @@ +Description of PR... + +## Changes + +- Item 1 +- Item 2 + +## Checklist + +- [ ] Unit tests +- [ ] Documentation + +## References + +(optional) + +Include **important** links regarding the implementation of this PR. +This usually includes and RFC or an aggregation of issues and/or individual conversations +that helped put this solution together. This helps ensure there is a good aggregation +of resources regarding the implementation. + +```text +Fixes #85, Fixes #22, Fixes username/repo#123 +Connects #123 +``` diff --git a/README.md b/README.md index 5c8e676..b1b434b 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ This repo holds Speckle's: - Default [Contribution Guidelines](.github/CONTRIBUTING.md), - README template (you're reading it now), - Default [Issue Template](.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md), +- Default [Pull Request Template](.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md), - OSS License (Apache 2.0) Either copy paste the parts that are useful in existing repos, or use this as a base when creating a new repository.