From dc2bb2b68bd4b41b3d1a8b02b93fd18d798bbd29 Mon Sep 17 00:00:00 2001 From: John Kjell Date: Tue, 9 Jan 2024 20:38:42 -0500 Subject: [PATCH 1/2] Initial attempt at PR and Issue templates Signed-off-by: John Kjell --- .github/ISSUE_TEMPLATE/bug-report.md | 25 ++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 36 +++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 6 ++++ 3 files changed, 67 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..aca9f5b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,25 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '[Bug]: ' +labels: ['bug', triage'] +assignees: '' +--- + +**What steps did you take and what happened:** + +[A clear and concise description of what the bug is.] + +**What did you expect to happen:** + +[Expected outcome listed here.] + +**Anything else you would like to add:** + +[Miscellaneous information that will assist in solving the issue.] + +**Environment:** + +- Witness version: +- Attestors used: +- Archivista version: diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..30394e12 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,36 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '[Feat]: ' +labels: ['feature', 'triage'] +assignees: '' + +--- + +**Describe the solution you'd like:** + +[A clear and concise description of what you want to happen.] + +**User value:** + +[Why will this feature be valuable to you? Why will this be valuable to others?] + +**Expected behavior:** + +[What would you like to see happen] + +**Proposed solution:** + +[If you're able, describe possible solution workflow] + +**Anything else you would like to add:** + +[Miscellaneous information that will assist in solving the issue.] + +**Testing changes required:** + +[List possible testing changes required, if none please explain] + +**Documentation changes required:** + +[List possible documentation changes required, if none please explain] diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..8e62f1e8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,6 @@ +**What this PR does / why we need it**: + +**Which issue(s) this PR fixes** *(optional, using `fixes #(, fixes #, ...)` format, will close the issue(s) when the PR gets merged)*: +Fixes # + +**Special notes for your reviewer**: From b4cbc95eb81790e70c623729499c34f49cf48ca3 Mon Sep 17 00:00:00 2001 From: John Kjell Date: Thu, 11 Jan 2024 13:05:07 -0500 Subject: [PATCH 2/2] Address some review feedback Signed-off-by: John Kjell --- .github/ISSUE_TEMPLATE/bug-report.md | 1 + .github/ISSUE_TEMPLATE/feature-request.md | 4 ++-- .github/PULL_REQUEST_TEMPLATE.md | 17 +++++++++++++++-- 3 files changed, 18 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index aca9f5b1..1efbee32 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -21,5 +21,6 @@ assignees: '' **Environment:** - Witness version: +- Architecture: - Attestors used: - Archivista version: diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 30394e12..a8540f67 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -29,8 +29,8 @@ assignees: '' **Testing changes required:** -[List possible testing changes required, if none please explain] +[List possible testing changes required, if none please explain, if unsure assignee will assist] **Documentation changes required:** -[List possible documentation changes required, if none please explain] +[List possible documentation changes required, if none please explain, if unsure assignee will assist] diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8e62f1e8..0d0d900f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,19 @@ -**What this PR does / why we need it**: +## What this PR does / why we need it + +Description + +## Which issue(s) this PR fixes (optional) + +(optional, using `fixes #(, fixes #, ...)` format, will close the issue(s) when the PR gets merged)* -**Which issue(s) this PR fixes** *(optional, using `fixes #(, fixes #, ...)` format, will close the issue(s) when the PR gets merged)*: Fixes # +## Acceptance Criteria Met + +- [ ] Docs changes if needed +- [ ] Testing changes if needed +- [ ] All workflow checks passing (automatically enforced) +- [ ] All review conversations resolved (automatically enforced) +- [ ] [DCO Sign-off](https://github.com/apps/dco) + **Special notes for your reviewer**: