diff --git a/contributing/codespace.md b/contributing/codespace.md index 20484bbf5c..ff90074db7 100644 --- a/contributing/codespace.md +++ b/contributing/codespace.md @@ -17,16 +17,17 @@ The steps described below assume you have GitHub Codespaces set up to edit files 1. Go to the `docs` repository: [https://github.com/github/docs](https://github.com/github/docs). 1. [Fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) to your own organization. 1. [Create a branch to work on](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository). -1. On the main page of the new `docs` repository, click the **Code** button and click **Create codespace on BRANCHNAME**. +1. On the main page of the new `docs` repository, click the **Code** button and click **Create codespace on BRANCHNAME**.
The "Setting up your codespace" page is displayed. After a short time the browser-based version of Visual Studio Code is displayed. -1. Use the Explorer to navigate to the markdown file you want to edit. This will be located below the `content` directory. +1. Use the Explorer to navigate to the markdown file you want to edit. This will be located below the `content` directory.
In most cases, the path to the file, below the `content` directory, matches the path in URL, minus the `.md` file name extension. For example, the source for the article https://docs.github.com/en/**codespaces/getting-started/quickstart** is the markdown file content/**codespaces/getting-started/quickstart**.md. 1. Edit the markdown file as required. 1. Save your changes. 1. Commit and push your changes, either using the Source Control pane, or using Git commands from the Terminal. For more information, see "[About Git](https://docs.github.com/en/get-started/using-git/about-git)." -1. Go to the **Pull requests** tab of the `github/docs` repository and click **New pull request**. +1. Go to the **Pull requests** tab of the `github/docs` repository: https://github.com/github/docs/pulls +1. Click **New pull request**. 1. Click **compare across forks** and choose the forked repository you created, and your working branch. 1. Check that the changes displayed include all of the changes you made in the codespace. If they do not, it indicates there are changes you have not pushed from the codespace to GitHub. 1. Click **Create pull request**. -1. Fill out the details for your pull request and click **Create pull request**. +1. Fill out the details for your pull request and click **Create pull request**.
Your pull request will be reviewed by a member of the GitHub documentation team.