wzulfikar/pull_request_template.md

Last active October 12, 2022 18:30

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/wzulfikar/439675fcf5517f9fa23c6ce465856744.js"></script>
Save wzulfikar/439675fcf5517f9fa23c6ce465856744 to your computer and use it in GitHub Desktop.

PR Template

Raw

🚧 Work in progress

What does this PR change, add, or delete?

Why is this PR needed?

Before	After

What steps can reviewer do to verify that this PR works as expected? Remove this section if not needed.

Author

Template for Github PR (see docs for ref). Inspired by Gumroad.

Usage

Put the pull_request_template.md in your .github folder of your repo
If you want to ensure that users will not submit empty issue, set blank_issues_enabled to false (ref)

Workflow

If you use Github CLI to create the PR, you'll be prompted with "Choose a template". If you use VSCode to create the PR, your PR description will be automatically filled with the template.
Once you submitted the PR, visit the PR in your browser and update the content accordingly (add What, Why, etc.)
Once you've done updating, remove the "🚧 Work in progress" from the top of PR description. This text acts as a "marker" to indicate if the description has been populated with the actual content or if it's still the template's default.

Select an option