Skip to content
This repository has been archived by the owner on Nov 5, 2024. It is now read-only.

Commit

Permalink
PR template readability and standardization fixes (#3319)
Browse files Browse the repository at this point in the history
* PR template readability and standardization enhancements

* PR template check styling changed

* PR template table change

* PR template - little fixes

* PR template - removed unnecessary 'please'

* PR template small fixes
  • Loading branch information
CodinGeo authored Jul 10, 2024
1 parent ff186b5 commit ddf583f
Showing 1 changed file with 44 additions and 25 deletions.
69 changes: 44 additions & 25 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,71 @@
## Pull Request (PR) Checklist
## Pull request (PR) checklist

Please check if your pull request fulfills the following requirements:

<!-- 💡 Tip: Tick checkboxes like this: [x] -->

- [ ] The PR is submitted to the `main` branch.
- [ ] I've read the [Contribution Guidelines](https://github.com/Ivy-Apps/ivy-wallet/blob/main/CONTRIBUTING.md) and my PR doesn't break the rules.
- [ ] I've read and understand the [Developer Guidelines](https://github.com/Ivy-Apps/ivy-wallet/blob/main/docs/Guidelines.md).
- [ ] I confirm that I've run the code locally and everything works as expected.
- [ ] 🎬 I've attached a **screen recoding** of the changes.
- [ ] My PR includes only the necessary changes to fix the issue (i.e., no unnecessary files or lines of code are changed).
- [ ] 🎬 I've attached a **screen recording** of using the new code to the next paragraph (if applicable).


## Screen recording of interacting with your changes:

<!-- 💡 Tip: Drag & drop the video here. -->


> Tip: drag & drop the video to the PR description.

## What's changed?
<!--
Tip: you can attach screenshots using a markdown table.
Describe with a few bullets **what's new:**

<!-- 💡 Tip: After each more important point leave one line empty and show your changes in markdown table with screenshots or screen recordings replacing {media}. In the end, it should look like this:
Before | After
--|--
image1 | image2
- I've fixed...
Before|After
-------|-------
{media}|{media}
{media}|{media}
-->

Describe with a few bullets **what's new:**
- a
- b
- c

> 💡 Tip: Please, attach screenshots and screen recordings. It helps a lot!
- ...


- ...


## Risk Factors
## Risk factors

**What may go wrong if we merge your PR?**

- a
- b
- ...
- ...

**In what cases your code won't work?**
**In what cases won't your code work?**

- a
- b
- ...
- ...

## Does this PR closes any GitHub Issues?

Check **[Ivy Wallet Issues](https://github.com/Ivy-Apps/ivy-wallet/issues)**.
## Does this PR close any GitHub issues?

- Closes #ISSUE_NUMBER
- Closes #{ISSUE_NUMBER}
<!-- For example:
> Replace `ISSUE_NUMBER` with the number of the GitHub issue that this PR is fixing. If you've done that correctly, you'll see the issue title linked when previewing your PR description.
- Closes #123
-->

<!-- 💡 Tip: Replace {ISSUE_NUMBER} with the number of Ivy Wallet ISSUE (https://github.com/Ivy-Apps/ivy-wallet/issues) (❗NOT PR❗) which this pull request fixes. If done correctly, you'll see the issue title linked on PR preview. -->

<!-- 💡 Tip: Multiple issues:
- Closes #{ISSUE_NUMBER_1}, closes #{ISSUE_NUMBER_2}, closes #{ISSUE_NUMBER_3}
-->

> **!Note:** Do **not** link the PR number. Link the number/id of the GitHub Issue from [issues](https://github.com/Ivy-Apps/ivy-wallet/issues).

## Troubleshooting CI failures ❌

GitHub Actions failing? Read our [CI Troubleshooting guide](https://github.com/Ivy-Apps/ivy-wallet/blob/main/docs/CI-Troubleshooting.md).
Pull request checks failing? Read our [CI Troubleshooting guide](https://github.com/Ivy-Apps/ivy-wallet/blob/main/docs/CI-Troubleshooting.md).

0 comments on commit ddf583f

Please sign in to comment.