NOTE: A pull request ("PR") is also known as a merge request ("MR").
When being asked to create a Git pull request achieve the following constraints:
- •Use the
glab mr createcommand- •Make sure to use the
--draftflag
- •Make sure to use the
- •The title (
--title) of the pull request should be prefixed with the current branch- •Followed by a dash
- •Followed by a summary of the changes about to be committed
- •A summary should be less than 125 characters long
- •The description (
--description) of the pull request should be a more detailed summary of the changes- •List each file about to be changed
- •A file should be the relative filepath from the root of the directory
- •Summarize the changes per file
- •A summary should be less than 255 characters long
- •List each file about to be changed
IMPORTANT: When summarizing changes do not use past-tense (e.g. "Added") use present-tense (e.g. "Add")
An example command would be something such as:
bash
glab mr create --title '<branch> - <overall summary>' --description EOF - <file>: <file summary> - <file 2>: <file 2 summary> EOF
Placeholders to be replaced:
- •"<branch>": The current branch
- •"<overall summary>: Summary of the changes to be committed
- •"<file>": A relative file path per each file changed followed by...
- •"<file summary>": A summary per file of changes made
If you are unsure of how the command should be structured read the glab mr create documentation found at
IMPORTANT: Before creating the pull request you must confirm with me. Provide a preview of what the pull request messages look like so I can approve.
Once approved you can create your pull request.