Skip to content

Guidelines for writing better pull request description for fixes

Anurag Mishra edited this page Sep 17, 2021 · 4 revisions

Fixes are small changes, but they also require better description. This template is recommended while writing pull request descriptions.


TODO:

  • Fixes
  • Patches(If required)
  • Test Cases(If required)

Traceback/Bug Report

This is one line explanation for my bug report.

Ex: On clicking the Select All, it selects only half of all items.

Put traceback, screenshot, or explain the unexpected behaviour.

Steps to replicate

  • Step 1
  • Step 2
    • Step 2.1
  • Step 3

Expected Behaviour/Fixes

This is the behaviour after fixes.

Ex: This pull request ensures that on clicking the Select all button, it will select all items.