archive-gh-me/rollup-plugin-typescript2
1
0
Fork 0
mirror of https://github.com/ezolenko/rollup-plugin-typescript2.git synced 2025-12-08 19:06:16 +00:00
Code Issues Projects Releases Wiki Activity

github: add a Pull Request template (#370)

Browse Source 
- keeping it short and simple for now, but this is basically the format that the majority of my PRs follow
  - can add more sections or optional sections as needed in the future

- this should help keep PRs consistent, which makes them easier to read and review
  - (similar rationale as that for code style consistency)
- should also help preserve the historical context and rationale behind PRs
  - which also makes reviews _significantly_ easier and involve less guesswork
  - which can be very important for figuring out the intent of code
    - which can be particularly important when trying to decipher if a piece of code was written intentionally for a specific purpose, or accidentally has a bug in it, or is redundant, etc
    - while comments serve a similar function, not all code is commented and the overall purpose of a PR may not necessarily fit into any line of the code
      - or it may only be relevant historically, and not necessarily relevant to a piece of code's current functionality
    - etc etc etc etc
- also requests a small bar of quality from PR authors as well
This commit is contained in:
Anton Gilgur 2022-06-29 01:41:18 -04:00 committed by GitHub
parent 67f1d86a96
commit 6977f30ce8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.github/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,12 @@
## Summary
<!--
A short, 1-3 sentence summary of what this PR changes.
Add "Fixes #<issue-num>" if this resolves a particular issue.
-->
## Details
<!--
A **detailed** description of what this PR changes and _why_ it changes that.
-->