Skip to content

Commit

Permalink
docs: minimize PULL_REQUEST_TEMPLATE.md #5485
Browse files Browse the repository at this point in the history
Problem
-------
For better or worse, PRs tend to be squash-merged, so devs tend to
neglect commit messages, and the PR description (as opposed to commit
messages) contains the relevant info.

Therefore to encourage a useful git commit history, we have configured
the github repo to use the PR description as the "Default commit
message".

But the `PULL_REQUEST_TEMPLATE.md` contains a lot of boilerplate that
would then get pasted into the merged commit message unless the merging
party takes time to delete it.

Solution
--------
Minimize `PULL_REQUEST_TEMPLATE.md` boilerplate to avoid lots of noise
in the git commit messages.
  • Loading branch information
justinmk3 authored Aug 23, 2024
1 parent 958db88 commit 8c55eb0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 13 deletions.
22 changes: 9 additions & 13 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
## Problem
Problem
-------

## Solution

<!---
REMINDER:
- Read CONTRIBUTING.md first.
- Add test coverage for your changes.
- Update the changelog using `npm run newChange`.
- Link to related issues/commits.
- Testing: how did you test your changes?
- Screenshots (if the pull request is related to UI/UX then please include light and dark theme screenshots)
-->
Solution
--------

## License

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
---

<!--- REMINDER: Ensure that your PR meets the guidelines in CONTRIBUTING.md -->

License: I confirm that my contribution is made under the terms of the Apache 2.0 license.
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
out
CHANGELOG.md
.github/PULL_REQUEST_TEMPLATE.md
.changes
*.d.ts
*.gen.ts
Expand Down

0 comments on commit 8c55eb0

Please sign in to comment.