A guide to idiomatic pull requests

1. Make PR templates

Feature template -

## Description
Add bullet points or short summary about the change. Also, include the relevant
motivation and context.
## Screenshots### Before### Now## Test cases covered -
[ ] verified theming
[ ] verified responsiveness
[ ] added unit tests
[ ] -- add relevant test cases to be covered here
## Edge cases covered -
- edge case 1
- edge case 2
## Endpoints
- URL endpoint
- login credentials
## Checklist -
[ ] Needs design review
[ ] Verified DOD
[ ] -- add relevant checklist items here

Bug template -

## Issue
Add a short summary describing the reported bug
## Root cause
Describe the root cause of the bug
## Fix
Explain the implemented fixed for the issue
## Screenshots### Before### Now## Edge cases covered -
- edge case 1
- edge case 2
## Endpoints
- URL endpoint
- login credentials
## Checklist -
[ ] Needs design review
[ ] Verified DOD
[ ] -- add relevant checklist items here

2. Use screenshots or screen capture

3. Smart PR heading

Ticket ID:

Feature or Bug:

Description:

4. Use correct tags

  1. Assignee — there should only be one assignee per PR
  2. Reviewers — Add other reviewers here who can contribute to the PR review process
  3. Labels — Create labels for the different features you have in your project, and some custom labels like “needs design review”, “on hold” etc, and tag the correct labels for each PR
  4. Milestone — Create milestones for each release and tag the correct milestone for each PR

5. Be empathetic

  • use buttle points instead of big paragraphs.
  • Don’t copy-paste the ticket info if it doesn’t provide full context.
  • Read your PR request in preview mode at least once before creating it and try to read it from the point of view of a reviewer.
  • Ask yourself these questions — Am I providing the full context of this PR to the reviewer? Am I being too verbose with my description? Have I pointed out the potential edge cases?
  • Also, keep an eye out for good PRs habits and incorporate those changes in your future PRs.

Benefits of doing this -

--

--

--

Hello, world! I’m a JavaScript developer who likes writing articles in my free time.

Love podcasts or audiobooks? Learn on the go with our new app.

Recommended from Medium

What Are Magento Extensions and How Do They Help Your Business

How to convert different visitors into customers on your website

Eight Ways To Keep Your Donor Database Clean

The science of staying top of mind with customers

Trying to use content marketing to sneak your way onto Santa’s nice list?

Website Migration — The Ultimate Checklist To Successfully Your Website To A New Host

Shopify Reviews 2020 — Why Is It The Best eCommerce Website Builder

8 Essential Skills For A Successful Dropshipping Business

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store
Srijan Gulati

Srijan Gulati

Hello, world! I’m a JavaScript developer who likes writing articles in my free time.

More from Medium

How To Create A New GitHub Organization With An OAuth App Setup

Key design principles in software development

Outside in Test Driven Development

How to rescue multiple exception classes with Ruby Exception