Skip to content

Commit

Permalink
Initial attempt at PR and Issue templates (#351)
Browse files Browse the repository at this point in the history
* Initial attempt at PR and Issue templates

Signed-off-by: John Kjell <john@testifysec.com>

* Address some review feedback

Signed-off-by: John Kjell <john@testifysec.com>

---------

Signed-off-by: John Kjell <john@testifysec.com>
Co-authored-by: Tom Meadows <tom@tmlabs.co.uk>
  • Loading branch information
jkjell and ChaosInTheCRD authored Jan 17, 2024
1 parent 83ca942 commit 1a9b5a2
Show file tree
Hide file tree
Showing 3 changed files with 81 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
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:
- Architecture:
- Attestors used:
- Archivista version:
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -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, if unsure assignee will assist]

**Documentation changes required:**

[List possible documentation changes required, if none please explain, if unsure assignee will assist]
19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## What this PR does / why we need it

Description

## Which issue(s) this PR fixes (optional)

(optional, using `fixes #<issue number>(, fixes #<issue_number>, ...)` 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**:

0 comments on commit 1a9b5a2

Please sign in to comment.