Skip to content

Commit

Permalink
Update pull_request_template.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Olshansk authored Jan 23, 2025
1 parent bb631a2 commit ddf1371
Showing 1 changed file with 13 additions and 41 deletions.
54 changes: 13 additions & 41 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,15 @@
<!-- READ & DELETE:
1. Add a descriptive title `[<Tag>] <DESCRIPTION>`
2. Update _Assignee(s)_
3. Add _Label(s)_
4. Set _Project(s)_
5. Specify _Epic_ and _Iteration_ under _Project_
6. Set _Milestone_
-->

## Summary

<!-- READ & DELETE:
- Providing a quick summary of the changes yourself
-->
< One line summary>

## Issue
Changes:
- < Change 1 >
- < Change 2 >

<!-- 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._
-->
## Issue

- #{ISSUE_NUMBER}
- Description: < Description >
- Issue: #{ISSUE_NUMBER}

## Type of change

Expand All @@ -33,28 +22,11 @@ Select one or more from the following:
- [ ] Documentation
- [ ] Other (specify)

## Testing

<!-- 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)
-->

- [ ] **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

0 comments on commit ddf1371

Please sign in to comment.