From 24b4f9b5d703b864cc553c5eb8d438a83858897a Mon Sep 17 00:00:00 2001 From: tobi <31960611+tsmethurst@users.noreply.github.com> Date: Fri, 9 Dec 2022 12:57:07 +0100 Subject: [PATCH] [chore] make single pull request template (#1239) When you have multiple templates, they can only be selected by the API, so you can't just open a pull request via the web UI and have the template presented to you. This should fix that by having just one pull request template. --- .github/PULL_REQUEST_TEMPLATE/bugfix.md | 15 ----------- .../PULL_REQUEST_TEMPLATE/documentation.md | 3 --- .github/PULL_REQUEST_TEMPLATE/feature.md | 16 ------------ .github/pull_request_template.md | 26 +++++++++++++++++++ 4 files changed, 26 insertions(+), 34 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE/bugfix.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/documentation.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/feature.md create mode 100644 .github/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/bugfix.md b/.github/PULL_REQUEST_TEMPLATE/bugfix.md deleted file mode 100644 index e610a1389..000000000 --- a/.github/PULL_REQUEST_TEMPLATE/bugfix.md +++ /dev/null @@ -1,15 +0,0 @@ -# Description - -> Please include a summary of the change and which issue is fixed. - -Fixes # (issue) - -# Checklist: - -- [ ] I have read the [GoToSocial contribution guidelines](https://github.com/superseriousbusiness/gotosocial/blob/main/CONTRIBUTING.md). -- [ ] I have performed a self-review of my own code. -- [ ] I have commented my code, particularly in hard-to-understand areas. -- [ ] I have made any necessary changes to documentation. -- [ ] New and existing tests pass locally with my changes. -- [ ] I have run `go fmt ./...` and `golangci-lint run`. -- [ ] I have added tests that prove my fix is effective. diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation.md b/.github/PULL_REQUEST_TEMPLATE/documentation.md deleted file mode 100644 index 996855286..000000000 --- a/.github/PULL_REQUEST_TEMPLATE/documentation.md +++ /dev/null @@ -1,3 +0,0 @@ -# Description - -> Please briefly explain the documentation change that you've made, and why. diff --git a/.github/PULL_REQUEST_TEMPLATE/feature.md b/.github/PULL_REQUEST_TEMPLATE/feature.md deleted file mode 100644 index 63f497980..000000000 --- a/.github/PULL_REQUEST_TEMPLATE/feature.md +++ /dev/null @@ -1,16 +0,0 @@ -# Description - -> Please include a summary of the feature you've coded, and link to the issue that it closes/implements. - -Implements # (issue) - -# Checklist: - -- [ ] I have read the [GoToSocial contribution guidelines](https://github.com/superseriousbusiness/gotosocial/blob/main/CONTRIBUTING.md). -- [ ] I have discussed my implementation already, either in an issue on the repository, or in the Matrix chat. -- [ ] I have performed a self-review of my own code. -- [ ] I have commented my code, particularly in hard-to-understand areas. -- [ ] I have made any necessary changes to documentation. -- [ ] New and existing tests pass locally with my changes. -- [ ] I have run `go fmt ./...` and `golangci-lint run`. -- [ ] I have added tests that cover my new code. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..10ecf8e4a --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,26 @@ +# Description + +> If this is a code change, please include a summary of what you've coded, and link to the issue(s) it closes/implements. +> +> If this is a documentation change, please briefly describe what you've changed and why. + +This pull request implements xyz or fixes abc. + +closes #(issue) +closes #(another issue) + +## Checklist + +Please put an x inside each checkbox to indicate that you've read and followed it: `[ ]` -> `[x]` + +If this is a documentation change, only the first checkbox must be filled (you can delete the others if you want). + +- [ ] I/we have read the [GoToSocial contribution guidelines](https://github.com/superseriousbusiness/gotosocial/blob/main/CONTRIBUTING.md). +- [ ] I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat. +- [ ] I/we have performed a self-review of added code. +- [ ] I/we have written code that is legible and maintainable by others. +- [ ] I/we have commented the added code, particularly in hard-to-understand areas. +- [ ] I/we have made any necessary changes to documentation. +- [ ] I/we have added tests that cover new code. +- [ ] I/we have run tests and they pass locally with the changes. +- [ ] I/we have run `go fmt ./...` and `golangci-lint run`.