From 7511ae532ed3266597194d4316234e50fd5ede25 Mon Sep 17 00:00:00 2001 From: Earl Warren Date: Mon, 22 Jul 2024 05:23:54 +0000 Subject: [PATCH] docs: add a PR checklist template (#4564) Manual testing of this template can be done with the new playground created for that purpose, see https://code.forgejo.org/forgejo/pr-and-issue-templates/pulls/19. ![image](/attachments/1ee36ae1-669f-47d8-8307-9734faa0dc2a) ## Testing instructions * Fork https://code.forgejo.org/forgejo/pr-and-issue-templates * Create a pull request against https://code.forgejo.org/forgejo/pr-and-issue-templates * See that the commit message is on top and the checklist below it --- Use cases: * https://codeberg.org/forgejo/forgejo/pulls/4553 * https://codeberg.org/forgejo/forgejo/pulls/4554 Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/4564 Reviewed-by: 0ko <0ko@noreply.codeberg.org> Reviewed-by: twenty-panda Reviewed-by: thefox Co-authored-by: Earl Warren Co-committed-by: Earl Warren --- .../issue_template/bug-report-ui.yaml | 0 .../issue_template/bug-report.yaml | 0 .../issue_template/config.yml | 0 .../issue_template/feature-request.yaml | 0 .forgejo/pull_request_template.md | 33 +++++++++++++++++++ .gitea/pull_request_template.md | 13 -------- 6 files changed, 33 insertions(+), 13 deletions(-) rename {.gitea => .forgejo}/issue_template/bug-report-ui.yaml (100%) rename {.gitea => .forgejo}/issue_template/bug-report.yaml (100%) rename {.gitea => .forgejo}/issue_template/config.yml (100%) rename {.gitea => .forgejo}/issue_template/feature-request.yaml (100%) create mode 100644 .forgejo/pull_request_template.md delete mode 100644 .gitea/pull_request_template.md diff --git a/.gitea/issue_template/bug-report-ui.yaml b/.forgejo/issue_template/bug-report-ui.yaml similarity index 100% rename from .gitea/issue_template/bug-report-ui.yaml rename to .forgejo/issue_template/bug-report-ui.yaml diff --git a/.gitea/issue_template/bug-report.yaml b/.forgejo/issue_template/bug-report.yaml similarity index 100% rename from .gitea/issue_template/bug-report.yaml rename to .forgejo/issue_template/bug-report.yaml diff --git a/.gitea/issue_template/config.yml b/.forgejo/issue_template/config.yml similarity index 100% rename from .gitea/issue_template/config.yml rename to .forgejo/issue_template/config.yml diff --git a/.gitea/issue_template/feature-request.yaml b/.forgejo/issue_template/feature-request.yaml similarity index 100% rename from .gitea/issue_template/feature-request.yaml rename to .forgejo/issue_template/feature-request.yaml diff --git a/.forgejo/pull_request_template.md b/.forgejo/pull_request_template.md new file mode 100644 index 0000000000..eca6f12ae6 --- /dev/null +++ b/.forgejo/pull_request_template.md @@ -0,0 +1,33 @@ +--- + +name: "Pull Request Template" +about: "Template for all Pull Requests" +labels: + +- test/needed + +--- + +## Checklist + +The [developer guide](https://forgejo.org/docs/next/developer/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). + +### Tests + +- I added test coverage for Go changes... + - [ ] in their respective `*_test.go` for unit tests. + - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. +- I added test coverage for JavaScript changes... + - [ ] in `web_src/js/*.test.js` if it can be unit tested. + - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). + +### Documentation + +- [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. +- [ ] I did not document these changes and I do not expect someone else to do it. + +### Release notes + +- [ ] I do not want this change to show in the release notes. +- [ ] I want the title to show in the release notes with a link to this pull request. +- [ ] I want the content of the `release-notes/.md` to be be used for the release notes instead of the title. diff --git a/.gitea/pull_request_template.md b/.gitea/pull_request_template.md deleted file mode 100644 index 00b874fd5b..0000000000 --- a/.gitea/pull_request_template.md +++ /dev/null @@ -1,13 +0,0 @@ ---- - -name: "Pull Request Template" -about: "Template for all Pull Requests" -labels: - -- test/needed - ---- -