Skip to content

Commit 8c55eb0

Browse files
authored
docs: minimize PULL_REQUEST_TEMPLATE.md aws#5485
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.
1 parent 958db88 commit 8c55eb0

File tree

2 files changed

+10
-13
lines changed

2 files changed

+10
-13
lines changed

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+9-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
1-
## Problem
1+
Problem
2+
-------
23

3-
## Solution
44

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

15-
## License
168

17-
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
9+
---
10+
11+
<!--- REMINDER: Ensure that your PR meets the guidelines in CONTRIBUTING.md -->
12+
13+
License: I confirm that my contribution is made under the terms of the Apache 2.0 license.

Diff for: .prettierignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
out
22
CHANGELOG.md
3+
.github/PULL_REQUEST_TEMPLATE.md
34
.changes
45
*.d.ts
56
*.gen.ts

0 commit comments

Comments
 (0)