Skip to content

Commit

Permalink
docs(contributing): add pr template
Browse files Browse the repository at this point in the history
Signed-off-by: gacallea <3269984+gacallea@users.noreply.github.com>
  • Loading branch information
andreacfromtheapp committed Aug 13, 2024
1 parent 31ad55b commit 5372423
Showing 1 changed file with 87 additions and 0 deletions.
87 changes: 87 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Pull request template

<!--
For Work In Progress Pull Requests, please use the Draft PR feature, see
https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further
details.
For a timely review/response, please avoid force-pushing additional commits if
your PR already received reviews or comments.
NOTE: Pull Requests from forked repositories will need to be reviewed by a
Team member before any CI builds will run.
-->

## Before submitting a pull request

Please make sure you've done the following:

- [ ] Read the [Contributing Guide](./github/CONTRIBUTING.md)
- [ ] Read the [Code Of Conduct](/CODE_OF_CONDUCT.md)
- [ ] Include tests for your changes (if any)
- [ ] Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
- [ ] Update any related documentation and include any relevant screenshots (if any)

## Pull request type (check all applicable)

- [ ] Refactor
- [ ] Feature
- [ ] Bug Fix
- [ ] Optimization
- [ ] Documentation

## Description

## Related Tickets & Documents

<!--
For pull requests that relate or close an issue, please include them
below. We like to follow [GitHub's guidance on linking issues to pull
requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
For example having the text: "closes #1234" would connect the current pull
request to issue 1234. And when we merge the pull request, GitHub will
automatically close the issue.
-->

- Related discussion #
- Related issue #
- Closes issue #

## QA Instructions, Screenshots, Recordings

_Please replace this line with instructions on how to test your changes, a note
on the devices and browsers this has been tested on, as well as any relevant
images for UI changes._

### UI accessibility checklist

_If your PR includes UI changes, please utilize this checklist:_

- [ ] Semantic HTML implemented?
- [ ] Keyboard operability supported?
- [ ] Checked with [axe DevTools](https://www.deque.com/axe/) and addressed
`Critical` and `Serious` issues?
- [ ] Color contrast tested?

_For more info, check out the [Forem Accessibility
Docs](https://developers.forem.com/frontend/accessibility)._

## Added/updated tests?

_We encourage you to keep the code coverage percentage at 80% and above._

- [ ] Yes
- [ ] No, and this is why: _please replace this line with details on why tests
have not been included_
- [ ] I need help with writing tests

## [optional] Are there any post deployment tasks we need to perform?

## [optional] What gif best describes this PR or how it makes you feel?

![alt_text](gif_link)

0 comments on commit 5372423

Please sign in to comment.