From 877e343f73326a2c6b0e0c35d7ee296e7c3e8992 Mon Sep 17 00:00:00 2001 From: James Ward Date: Sun, 25 Oct 2020 23:22:48 -0400 Subject: [PATCH] chore: include support message on templates & create PR template --- .github/ISSUE_TEMPLATE/bug-report.md | 8 ++-- .github/ISSUE_TEMPLATE/documentation-issue.md | 14 +++++- .github/ISSUE_TEMPLATE/feature-request.md | 14 +++++- .github/PULL_REQUEST_TEMPLATE.md | 47 +++++++++++++++++++ 4 files changed, 75 insertions(+), 8 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 2db7dc346..aa3d4af13 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -11,9 +11,9 @@ assignees: '' Please follow the template. If you don't, your issue may be closed. Have a question? This is the TypeORM issue tracker - and not the right place - for general support or questions. + for general support or questions. Instead, check the "Support" Documentation + on the best places to ask questions! - Check the "Support" Documentation on the best places to ask questions! https://github.com/typeorm/typeorm/blob/master/docs/support.md --> @@ -113,7 +113,7 @@ assignees: '' ### Are you willing to resolve this issue by submitting a Pull Request? - [ ] Yes, I have the time, and I know how to start. @@ -123,5 +123,5 @@ assignees: '' diff --git a/.github/ISSUE_TEMPLATE/documentation-issue.md b/.github/ISSUE_TEMPLATE/documentation-issue.md index 6efa7f992..cf3140298 100644 --- a/.github/ISSUE_TEMPLATE/documentation-issue.md +++ b/.github/ISSUE_TEMPLATE/documentation-issue.md @@ -7,6 +7,16 @@ assignees: '' --- + + ## Documentation Issue ### What was unclear or otherwise insufficient? @@ -65,7 +75,7 @@ assignees: '' ### Are you willing to resolve this issue by submitting a Pull Request? - [ ] Yes, I have the time, and I know how to start. @@ -75,5 +85,5 @@ assignees: '' diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index a250dadc7..c2b13944b 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -7,6 +7,16 @@ assignees: '' --- + + ## Feature Description ### The Problem @@ -75,7 +85,7 @@ assignees: '' ### Are you willing to resolve this issue by submitting a Pull Request? - [ ] Yes, I have the time, and I know how to start. @@ -85,5 +95,5 @@ assignees: '' diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..fd33e7cbf --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,47 @@ + + +### Description of change + + + + +### Pull-Request Checklist + + + +- [ ] Code is up-to-date with the `master` branch +- [ ] `npm run lint` passes with this change +- [ ] `npm run test` passes with this change +- [ ] This pull request links relevant issues as `Fixes #0000` +- [ ] There are new or updated unit tests validating the change +- [ ] Documentation has been updated to reflect this change +- [ ] The new commits follow conventions explained in [CONTRIBUTING.md](https://github.com/typeorm/typeorm/blob/master/CONTRIBUTING.md) + +