Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create pull_request_template.md #4518

Merged
merged 4 commits into from Apr 29, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/pull_request_template.md
@@ -0,0 +1,17 @@
- [ ] Link to pivotal/JIRA issue
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was expecting these to be headers (like ##) instead of checkboxes, and then the person filling this our just adds their thoughts under it, what do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, I suppose headers make a little more sense.

rickreyhsig marked this conversation as resolved.
Show resolved Hide resolved
- [ ] What was done?
- Explain the implementation goals being solved or the feature with the reviewer in mind
- Mention any relevant issues or technical gotchas
rickreyhsig marked this conversation as resolved.
Show resolved Hide resolved
rickreyhsig marked this conversation as resolved.
Show resolved Hide resolved
- Alternatives considered
- [ ] How to test?
- Describe the testing approach taken to verify the changes, including:
- Unit/integration/manual tests
- Test data used
- Specify any relevant testing environments used (e.g., development, staging, demo, Heroku).
- Risk Assessment
- Risks or side effects associated with the changes and how they were mitigated.
- Highlight areas that may need extra attention during code review or testing.
- Paste SQL queries or output where relevant
- [ ] Screenshots (for visual change)
- Before | After
rickreyhsig marked this conversation as resolved.
Show resolved Hide resolved