Creating a PR

Github step-by-step

Review the Github primer

Create a local working environment

• To use GitHub Desktop: Follow the steps in Setting up a desktop environment
• To use the command line: see GitHub's guides on Setting up Git and Using Git

Make your change locally

1. 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)
   • 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"). You can publish that branch.
2. Now locate the file you want to edit by following the directory structure (when using GitHub Desktop, GitHub is typically under Documents) to the wcag/techniques or wcag/understanding folders, then choose whichever subfolder to reach your file (the Understanding documents are divided by WCAG version; the Techniques are divided by type).
3. Make the changes using your editor. Save frequently. Commit the changes to the new branch.

If you are working on a complex change and would like to check your changes locally as you work, you can run the build locally.

Note for IDE Users

Please consider disabling any settings along the lines of "format on save" when working on this repository. This will minimize noise that would make the actual changes difficult to pinpoint, and make the PR as easy as possible for the group to review.

Create the PR

1. 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.
   • Be sure that the PR description 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")
   • If your change impacts a single page, you can include @netlify /path/to/page in the PR description to influence which page the netlify bot will link to for the deploy preview (example)
2. After the pull request is created, a preview build will run automatically, and the Netlify bot will comment on the PR with a link to the top-level index page
   • If you are making a fairly complex change across multiple files, edit the PR description to include relevant links to make it easier for others to review