Skip to content

Commit

Permalink
A couple small improvements to the issue & PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Olshansk committed Oct 5, 2023
1 parent 1b248f6 commit ba42e46
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 16 deletions.
24 changes: 10 additions & 14 deletions .github/ISSUE_TEMPLATE/issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ assignees: ""
1. Update _Assignee(s)_
2. Add _Label(s)_
3. Set _Project(s)_
4. Specify _Epic_ and _Iteration_ under _Project_
5. Set _Milestone_
4. Set _Milestone_
5. After the issue is created: specify _Epic_ and _Iteration_ under the _Project_ section
-->

## Objective
Expand Down Expand Up @@ -59,26 +59,22 @@ assignees: ""
- Non-deliverable #2
- ...

## Testing
## General deliverables

<!-- DELETE THIS COMMENT BLOCK
Remove this section if not applicable.
Otherwise, update (add/remove) items from the list below as deemed necessary.
Remove sections that are not applicable to this PR.
-->

- [ ] **Run all unit tests**: `make test_all_unit`
- [ ] **Verify localnet manually**: See the instructions [here](TODO: add link to instructions)
- [ ] **Comments**: Add/update TODOs and comments alongside the source code so it is easier to follow.
- [ ] **Testing**: Add new tests (unit and/or E2E) to the test suite.
- [ ] **Makefile**: Add new targets to the Makefile to make the new functionality easier to use.
- [ ] **Documentation**: Update architectural or development READMEs; use [mermaid](https://mermaid-js.github.io/mermaid/) diagrams where appropriate.

## General deliverables
---

<!-- DELETE THIS COMMENT BLOCK
Remove this section if not applicable.
Otherwise, update (add/remove) items from the list below as deemed necessary.
Remove `Co-Owners` if not applicable.
-->

- [ ] **Documentation**: Add/Update TODOs, comments, READMEs and [mermaid](https://mermaid-js.github.io/mermaid/) diagrams where appropriate

---

**Creator**: [GitHub handle of issue owner]
**Co-Owners**: [OPTIONAL - GitHub handle of co-owner(s)]
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ Select one or more:

## Testing

- [ ] **Unit tests**: `make test_all_unit`
- [ ] **Manual Llocalnet**: See the instructions [here](TODO: add link to instructions)
- [ ] **Run all unit tests**: `make test_all_unit`
- [ ] **Verify Localnet manually**: See the instructions [here](TODO: add link to instructions)

## Sanity Checklist

Expand Down

0 comments on commit ba42e46

Please sign in to comment.