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 readability and standardization fixes #3319

Merged
merged 6 commits into from
Jul 10, 2024

Conversation

CodinGeo
Copy link
Contributor

Pull Request (PR) Checklist

Please check if your pull request fulfills the following requirements:

  • [✅] The PR is submitted to the main branch.
  • [✅] I've read the Contribution Guidelines and my PR doesn't break the rules.
  • [✅] I've read and understand the Developer Guidelines.
  • [✅] 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).

What's changed?

Overall preview look:

Before After
image image
image image

Describe with a few bullets what's new:

  • Changed proposed way of ticking checkboxes (to the way I did it here above) - more stands out especially in the dark mode, but I can bring back the previous normal checkbox style:
Before After
image image
  • Moved screen recording checkbox to last position for it to be next to the next paragraph to put this screen recording
  • Emphasised the need of screen recording of changes in use in one of the paragraphs (visible in the first pair of screenshots)
  • Made tips as comments, not this style
  • Made markdown table easy to use to showcase changes made:
Before After
image image
  • Changed a,b,c as placeholders to ...
  • Automated PR - issue assigning simplified
Before After
image image

Risk Factors

What may go wrong if we merge your PR?

  • It's a doc

In what cases your code won't work?

  • It's a doc (have a nice day to anyone reading this)

Does this PR closes any GitHub Issues?

Check Ivy Wallet Issues.

Troubleshooting CI failures ❌

GitHub Actions failing? Read our CI Troubleshooting guide.

Copy link
Collaborator

@ILIYANGERMANOV ILIYANGERMANOV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - left some comments

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Show resolved Hide resolved
@ILIYANGERMANOV ILIYANGERMANOV added the keep Keep it from automatically getting closed by Stale label Jul 10, 2024
@ILIYANGERMANOV ILIYANGERMANOV merged commit ddf583f into Ivy-Apps:main Jul 10, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
keep Keep it from automatically getting closed by Stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change UX of PR template
2 participants