Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pr template update #10

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# 🎟 JIRA Reference
https://hearsaysocial.atlassian.net/browse/[ TICKET_NUMBER ]
<!---
Provide a link to the corresponding JIRA ticket, as well
as any additional references tickets where necessary
--->

## 📝 Description
<!---
- Describe your changes in detail. If fixing a bug, include what the issue was and what you did you to resolve it.
- If this is for a new feature, describe what was added and any changes to existing code that may have been needed.
- Include extra detail for code changes that are tricky or may be difficult to read.
- If you have modified any configuration files, explain the context.
- List any dependencies that are required for this change.
--->

## 🖥️ Screen Recording/Screenshots/Feature GIFs
<!---
-Upload a screen recording or screenshots of changes being made
if this updates the UI in any way
-Screen recordings are preferred over GIFs
--->

## ✅ Checklist
<!--- Do not delete these checkboxes -->
- [ ] Performed a self-review of the code
- [ ] My code follows the style guidelines and [best practices](https://hearsaysocial.atlassian.net/wiki/spaces/FE/pages/2634973199/RECOMMENDATIONS) of this project
- [ ] Manually verified the change in the developer environment

## ✅ Tests
- [ ] Added unit tests that prove the fix is effective or that the feature works
- [ ] Added all necessary self-made screenshot tests
- [ ] Follow-up tests required
<!---
Include details of follow-up task if more testing is required e.g.:
-Could not write unit tests because of dependency issue... see follow-up task #123
-Un-attested states not currently covered
-->

- [ ] Special QA instructions required
<!---
Include instructions here if Special QA instructions are required beyond the follow-up tests,
or if this feature may cause unexpected changes in app behavior.
-If it fixes an open issue, please link to the issue here
--->

## ✅ Dependency and Documentation Updates
- [ ] I have made corresponding changes to any relevant documentation
- [ ] Any dependent changes have been merged and published in downstream modules
- [ ] I do not introduced deprecated packages and deprecation warnings

## 🎉 Party Time GIF
<!---
-Optional opportunity for a fun and relevant GIF!
-If using an online gif, use the following format for ease:
![](https://media3.giphy.com/media/l0MYxFjm1t4OejfOw/giphy.gif)
--->