epic-stack
epic-stack copied to clipboard
(github) introduce pull request template
Summary
This PR introduces a generic PR template to facilitate the description of the problem statement (Summary) and the inclusion of a test plan. The purpose is to provide reviewers with an easier way to test the work in new projects.
The intention is to cater to product companies and provide them with an efficient pull request template. While drawing inspiration from the pull request template available at React Testing Library, I have made modifications to streamline it and make it more suitable for broader adoption.
Test Plan
To validate the changes, follow these steps:
- Switch to the
main
branch:git checkout main
- Fetch the latest changes:
git fetch
- Merge the
epic-stack:docs/pr-template
branch:git merge epic-stack:docs/pr-template
- Switch to the
feat/cool-feature
branch:git checkout feat/cool-feature
- Commit your changes:
git commit
- Push the changes to the remote repository:
git push origin HEAD
- Open the pull request by navigating to the link displayed in your terminal.
Ensure that you can see the newly added pull request template after completing these steps.
Platform update
- [ ] Node Dependencies - bumping versions or adding a new dependency
Checklist
- [ ] Testing - Tests have been added to cover my changes.
- [ ]
data-testid
- Make sure that testIDs have been added or updated, more info at testing library docs.