Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
h5law authored May 24, 2023
1 parent 6e691a6 commit 40a648f
Showing 1 changed file with 75 additions and 0 deletions.
75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
name: Issue
about: General purpose issue for the SMT libarary
title: "[REPLACE ME] With a descriptive title"
labels: ''
assignees: ''

---

<!-- DELETE ME after following these instructions
1. Make sure to update the _Assigness_, _Labels_, _Projects_, _Milestone_ before submitting the issue\_
2. Make sure to add labels for the purpose (e.g. `enhancement`, `bug`) and priority (e.g. `low`) of this PR\_
-->

## Objective

[ What? Issue description]

## Origin Document

[ Why? Issue justification and/or link to another document]

## Goals

<!-- REMOVE this comment block after following the instructions
Make a list of high level tasks, ideas or goals driving the task. These should not be actionable deliverables.
-->

- Goal #1
- Goal #2
- ...

## Deliverable

<!-- REMOVE this comment block after following the instructions
Make a list of deliverables that are expected outputs of this task. These should be concrete and tangible.
-->

- [ ] Deliverable #1
- [ ] Deliverable #2
- ...

## Non-goals / Non-deliverables

<!-- REMOVE this comment block after following the instructions
Make a list goals and deliverables the assignee of the issue should not attempt to do so the scope does not become too large.
-->

- Nongoal #1
- Nongoal #2
- ...

## General issue deliverables

<!-- REMOVE this comment block after following the instructions
Remove any items that are not applicable and add additional ones, if applicable, that are not listed below.
-->

- [ ] Update any relevant README(s)
- [ ] Add or update any relevant or supporting [mermaid](https://mermaid-js.github.io/mermaid/) diagrams

## Testing Methodology

<!-- REMOVE this comment block after following the instructions
Remove this section if not applicable. Otherwise, update (add/remove) the list below as deemed necessary.
-->

- [ ] **Task specific tests or benchmarks**: `go test ...`
- [ ] **New tests or benchmarks**: `go test ...`
- [ ] **All tests**: `go test -v`

---

**Creator**: [github username of the creator]
**Co-Owners**: [optional - github usernames of the co-owner(s)]

0 comments on commit 40a648f

Please sign in to comment.