Open the pull request

Lesson 3 of 3 in Ship a first pull request. About 5 minutes.

In this lesson you offer your change to the project.

Steps

1. Push and open the pull request.

   git push -u origin fix/short-name
   gh pr create --fill

   Fill in the template. In the description write Fixes #<issue number>. Fill the Docs: line with updated or not affected.

   You should see: a link to your new pull request.

2. Name the area. Every pull request belongs to one area: reading, library, highlights, vocabulary, assistant, account, data, ops or documentation. The glossary says what each area holds. Only maintainers can set the label, so write the area in the description. The area-label check stays red until a maintainer adds it.

If something goes wrong

• The area-label check is red. Do nothing. A maintainer adds the label.
• The docs-links check is red. A link in a .md file points at a file that does not exist. Run node scripts/check-doc-links.mjs. It prints the file and the line.
• A check fails on something you did not touch. Say so in the pull request. A maintainer runs the check again.

Check yourself

• My pull request is open.
• Every check except area-label is green.
• The description links the issue and names the area.

Next

Before a larger change, see how TextStack works.