💻 Developer text templates: commit messages, PR descriptions and bug reports
Developers write the same few kinds of text every day: a commit message, a pull request description, a bug report, a review comment. Writing them well saves your teammates (and future you) a lot of guessing.
The templates below keep each one short and structured. Fill in the brackets, delete what does not apply, and save the pack to CopyCat so it is one click away next time.
[type]([scope]): [short summary in the imperative]
Why: [the problem this solves]
What: [the main change in one or two lines]
Refs: [issue or ticket link]
Pull request description
## What
[One or two sentences on the change]
## Why
[The problem or ticket this solves]
## How to test
1. [Step one]
2. [Step two]
## Notes for reviewers
[Anything risky, surprising or intentionally left out]
Bug report
**Summary:** [one line]
**Steps to reproduce**
1. [Step]
2. [Step]
**Expected:** [what should happen]
**Actual:** [what happens instead]
**Environment:** [OS, browser or app version]
**Logs or screenshots:** [attach]
Code review: request change
Thanks for this! One thing I would change here: [what and where]. The reason is [risk or benefit]. Something like [suggested approach] would work. Happy to discuss if you see it differently.
Code review: approve
Looks good to me. I checked [what you looked at] and it does what the description says. Nit (not blocking): [optional small suggestion]. Approving.
Daily standup update
Yesterday: [what you finished]
Today: [what you will work on]
Blockers: [what is in your way, or none]
Incident update
**Status:** [investigating / identified / monitoring / resolved]
**Impact:** [who or what is affected]
**Started:** [time]
**What we know:** [facts only]
**Next update:** [time]
Ask for help in chat
I am working on [task] and I am stuck on [specific problem]. What I expected: [x]. What I see: [y]. I already tried [a] and [b]. Could someone point me in the right direction? Relevant code or logs: [link]