Skip to content

Commit

Permalink
Update pull_request_template.md (#748)
Browse files Browse the repository at this point in the history
Make the PR template more readable.
  • Loading branch information
Olshansk authored Aug 21, 2024
1 parent cb81e9c commit 2788178
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- README: DELETE THIS COMMENT BLOCK after:
<!-- READ & DELETE:
1. Add a descriptive title `[<Tag>] <DESCRIPTION>`
2. Update _Assignee(s)_
3. Add _Label(s)_
Expand All @@ -9,13 +9,13 @@

## Summary

<!-- README: DELETE THIS COMMENT BLOCK after
- Providing a quick summary of the changes yourself
<!-- READ & DELETE:
- Providing a quick summary of the changes yourself
-->

## Issue

<!-- README: DELETE THIS COMMENT BLOCK after:
<!-- READ & DELETE:
- Explain the reasoning for the PR in 1-2 sentences. Adding a screenshot is fair game.
- If applicable: specify the ticket number below if there is a relevant issue; _keep the `-` so the full issue is referenced._
-->
Expand All @@ -34,20 +34,21 @@ Select one or more:

## Testing

**Documentation changes** (only if making doc changes)
- [ ] `make docusaurus_start`; only needed if you make doc changes
<!-- READ & DELETE:
- Documentation changes: only keep this if you're making documentation changes
- Unit Testing: Remove this if you didn't make code changes
- E2E Testing: Remove this if you didn't make code changes
- See the quickstart guide for instructions: https://dev.poktroll.com/developer_guide/quickstart
- DevNet E2E Testing: Remove this if you didn't make code changes
- THIS IS VERY EXPENSIVE: only do it after all the reviews are complete.
- Optionally run `make trigger_ci` if you want to re-trigger tests without any code changes
- If tests fail, try re-running failed tests only using the GitHub UI as shown [here](https://github.com/pokt-network/poktroll/assets/1892194/607984e9-0615-4569-9452-4c730190c1d2)
-->

**Local Testing** (only if making code changes)
- [ ] **Documentation**: `make docusaurus_start`; only needed if you make doc changes
- [ ] **Unit Tests**: `make go_develop_and_test`
- [ ] **LocalNet E2E Tests**: `make test_e2e`
- See [quickstart guide](https://dev.poktroll.com/developer_guide/quickstart) for instructions

**PR Testing** (only if making code changes)
- [ ] **DevNet E2E Tests**: Add the `devnet-test-e2e` label to the PR.
- **THIS IS VERY EXPENSIVE**, so only do it after all the reviews are complete.
- Optionally run `make trigger_ci` if you want to re-trigger tests without any code changes
- If tests fail, try re-running failed tests only using the GitHub UI as shown [here](https://github.com/pokt-network/poktroll/assets/1892194/607984e9-0615-4569-9452-4c730190c1d2)


## Sanity Checklist

Expand Down

0 comments on commit 2788178

Please sign in to comment.