From ba42e4639207c613204e1e61b968fb24f1910f57 Mon Sep 17 00:00:00 2001 From: Daniel Olshansky Date: Thu, 5 Oct 2023 13:15:03 -0400 Subject: [PATCH] A couple small improvements to the issue & PR templates --- .github/ISSUE_TEMPLATE/issue.md | 24 ++++++++----------- .../pull_request_template.md | 4 ++-- 2 files changed, 12 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue.md b/.github/ISSUE_TEMPLATE/issue.md index d81fccf99..479ba1ffe 100644 --- a/.github/ISSUE_TEMPLATE/issue.md +++ b/.github/ISSUE_TEMPLATE/issue.md @@ -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 @@ -59,26 +59,22 @@ assignees: "" - Non-deliverable #2 - ... -## Testing +## General deliverables -- [ ] **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 +--- -- [ ] **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)] diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index d8f0f0035..84e0509fd 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -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