Skip to content

Creating a PR

Mike Gower edited this page May 13, 2024 · 10 revisions

=== Github step-by-step ===

Review the Github primer

==== Create a local working environment ====

  1. Follow the steps in Setting up a desktop environment

  2. With the github client opened, and https://github.com/w3c/wcag cloned locally with the main branch selected, choose New branch (either from the button, or the Branch menu)

    1. give it a meaningful name; normally we suggest calling it the name of the issue it is trying to address, plus some context. For a change to a technique, you could use the technique number (for example "1234-H39"); for a change to an understanding document, you can use the issue plus understanding document shortname, (for example "1234-Focus-Visible") from main;
  3. Locate the file you want to edit by following the directory structure to the Techniques or Understanding folders, then choose whichever subfolder to reach your file (the Understanding documents are divided by WCAG version; the Techniques are divided by type).

  4. Make the changes using your editor. Save frequently. Commit the changes to main.

  5. Create a pull request (link, top-right). Make sure the first option is the working branch (e.g. 'main') and the second is your new branch.

    1. Be sure that the PR comment includes a reference to the issue it is addressing. If you precede the reference with "resolves" or "closes", when the PR is merged, it will automatically close the related issue (e.g. "resolves #1234"