-
Notifications
You must be signed in to change notification settings - Fork 256
Creating a PR
=== Github step-by-step ===
Review the Github primer
==== Create a local working environment ====
- Follow the steps in Setting up a desktop environment
==== Make your change locally ====
-
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.
-
Now locate the file you want to edit by following the directory structure (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).
-
Make the changes using your editor. Save frequently. Commit the changes to main.
==== Publish the PR ====
-
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 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")
-
If you are making a fairly complex change, consider generating a preview copy and including it in your PR to make it easier for others to review