Use a standard Pull Request Title format
Introduction
Use a standard method for titling Pull Requests.
Decision
Pull Requests take on the following format for the titles, matching a similar structure to the commit messaging standard. Body is optional.
Title:
JIRA-ID: Brief description of the feature(s) in the present tense
Example:
ABC-123: Update the environment to use PHP 14.3
Context
This is for a few reasons...
It’s important to reference the JIRA issue so that it’s easy to track back to the original request and get an understanding of the context of the change.
Adopting the same format as our commit message standard will keep team members on the same page when it comes to git commits and reviewing pull requests.
Consequences
- More work when creating a Pull Request.
Exceptions
- Do not revert and redo Pull Requests if they end up being in the incorrect format
- You are in a rush to fix the site.
Additional Resources
None