diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index dba8e6fea..f387c62d7 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,26 +1,15 @@ - - ## Summary - +< One line summary> -## Issue +Changes: +- < Change 1 > +- < Change 2 > - +## Issue -- #{ISSUE_NUMBER} +- Description: < Description > +- Issue: #{ISSUE_NUMBER} ## Type of change @@ -33,28 +22,11 @@ Select one or more from the following: - [ ] Documentation - [ ] Other (specify) -## Testing - - - -- [ ] **Documentation**: `make docusaurus_start`; only needed if you make doc changes -- [ ] **Unit Tests**: `make go_develop_and_test` -- [ ] **LocalNet E2E Tests**: `make test_e2e` -- [ ] **DevNet E2E Tests**: Add the `devnet-test-e2e` label to the PR. - ## Sanity Checklist -- [ ] I have tested my changes using the available tooling -- [ ] I have commented my code -- [ ] I have performed a self-review of my own code; both comments & source code -- [ ] I create and reference any new tickets, if applicable -- [ ] I have left TODOs throughout the codebase, if applicable +- [ ] I have updated the GitHub Issue `assignees`, `reviewers`, `labels`, `project`, `iteration` and `milestone` +- [ ] For docs, I have run `make docusaurus_start` +- [ ] For code, I have run `make go_develop_and_test` and `make test_e2e` +- [ ] For code, I have added the `devnet-test-e2e` label to run E2E tests in CI +- [ ] For configurations, I have update the documentation +- [ ] I added TODOs where applicable