How your pull request title serves as a documentation for your code changes

#git #webdev #beginners #tutorial

Hope you all know what a pull request is 😉

Often PRs are not well written, and it is hard to understand what the PR is about. In this article, we will learn how to write a good pull request title and how it can serve as a documentation for your code changes.

Short but descriptive title

Always write self explanatory pull request title to make it easier for the reviewer to understand what the PR is about.

# Less Descriptive
Fixing the bug

# More Descriptive
Fixing the bug in the login page

Include the affected areas of the code / feature

This helps reviewers quickly identify the context of the modifications,

# Ambiguous
Update styling

# Specific
Update styling for the navigation bar

Use action verbs

This creates a sense of action and purpose, and helps reviewers quickly identify the context of the modifications.

# Vague
Refactor code

# Actionable
Refactor authentication logic for enhanced security

I will share a separate article on how to write a good commit message, also followup on how to write good pull request description later. For now, please share your comments on twitter on what else can be done to improve the pull request title 🤞