Skip to content

Instantly share code, notes, and snippets.

@aarongodin
Last active December 10, 2022 04:33
Show Gist options
  • Save aarongodin/4c34080f0d50f5fb52ae4ca6e3e94278 to your computer and use it in GitHub Desktop.
Save aarongodin/4c34080f0d50f5fb52ae4ca6e3e94278 to your computer and use it in GitHub Desktop.
Personal Runbook PR
# new-pull-request
## Outcome
I've submitted my code for review and ensured confidence in the proposed changes.
## Prereqs
* My code is up to date in the remote repo in a branch off main.
* There are no dangling files to be saved or committed.
## Stakeholders
Generally will be the common contributors to the repository.
## Manifest
### Correctness
- [ ] Feature: check the issue/story description against my change. Assert any acceptance criteria is valid.
- [ ] Feature: exploratory testing - try to use the software in a way that is not covered by the story description or AC.
- [ ] Bug: exercise steps to reproduce from the ticket. Experiment with order of steps and adding unrelated steps.
### Code
- [ ] Comments are used when appropriate.
- [ ] Refactor: Read through the code again to check for performance pitfalls.
### Code (go)
- [ ] Check references to any newly added nilable values. Are nil checks added to avoid deref errors?
- [ ] Check for slice-of-pointers `for` loop issue
- [ ] `go mod tidy` has run
- [ ] `golangci-lint` has run
### Team
- [ ] Check on existing PRs in the repo. What is the ideal merge path if I know my code will have conflicts?
- [ ] Who will review my PR, and how will I notify them it's ready?
### Description (in the PR)
- [ ] Describes overview of additions and deletions to the code.
- [ ] Includes steps to test the PR with example output of running the steps.
- [ ] Anything I need a second set of eyes on? Areas of the code that need attention.
## Completion
Link to the PR here. Note any interesting results from the lifecycle of the PR from open to close.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment