steve/databricks-cli
steve
/
databricks-cli
mirror of https://github.com/databricks/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve the PR template, add a "why" section (#2402) 

## Changes
1. Add a Why section to the pull request template
2. Slightly improve language in the existing sections

## Why
Providing the right context for the reviewer in the PR description is
important as it usually cannot be inferred from the code itself. The new
section directly prompts the requester to provide such context

## Tests
Checked that the markdown is still rendered correctly in the local
viewer
This commit is contained in:
Anton Nekipelov 2025-02-28 15:33:32 +01:00 committed by GitHub
parent a2400f3025
commit 9056fb58b7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,6 +1,10 @@
## Changes ## Changes
<!-- Summary of your changes that are easy to understand --> <!-- Brief summary of your changes that is easy to understand -->
## Why
<!-- Why are these changes needed? Provide the context that the reviewer might be missing.
For example, were there any decisions behind the change that are not reflected in the code itself? -->
## Tests ## Tests
<!-- How is this tested? --> <!-- How have you tested the changes? -->