diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dad15934ad..189bcf1c03 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ You've already completed this step. ## Editing topics -We've tried to make editing an existing file as simple as possible. +We've tried to make editing an existing, public file as simple as possible. **To edit a topic** @@ -19,38 +19,42 @@ We've tried to make editing an existing file as simple as possible. ![GitHub Web, showing the Contribute link](images/contribute-link.png) -2. Click the **Pencil** icon (in the red box) to edit the content. +2. Log into (or sign up for) a GitHub account. + + You must have a GitHub account to get to the page that lets you edit a topic. + +3. Click the **Pencil** icon (in the red box) to edit the content. ![GitHub Web, showing the Pencil icon in the red box](images/pencil-icon.png) -3. Using markdown language, make your changes to the topic. For info about how to edit content using markdown, see: +4. Using markdown language, make your changes to the topic. For info about how to edit content using markdown, see: - **If you're linked to the Microsoft organization in GitHub:** [Windows Open Publishing Guide Home](http://aka.ms/windows-op-guide) - **If you're external to Microsoft:** [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) -4. Make your suggested change, and then click **Preview Changes** to make sure it looks correct. +5. Make your suggested change, and then click **Preview Changes** to make sure it looks correct. ![GitHub Web, showing the Preview Changes tab](images/preview-changes.png) -5. When you’re done editing the topic, scroll to the bottom of the page, and then click **Propose file change** to create a fork in your personal GitHub account. +6. When you’re done editing the topic, scroll to the bottom of the page, and then click **Propose file change** to create a fork in your personal GitHub account. ![GitHub Web, showing the Propose file change button](images/propose-file-change.png) The **Comparing changes** screen appears to see what the changes are between your fork and the original content. -6. On the **Comparing changes** screen, you’ll see if there are any problems with the file you’re checking in. +7. On the **Comparing changes** screen, you’ll see if there are any problems with the file you’re checking in. If there are no problems, you’ll see the message, **Able to merge**. ![GitHub Web, showing the Comparing changes screen](images/compare-changes.png) -7. Click **Create pull request**. +8. Click **Create pull request**. -8. Enter a title and description to give the approver the appropriate context about what’s in the request. +9. Enter a title and description to give the approver the appropriate context about what’s in the request. -9. Scroll to the bottom of the page, making sure that only your changed files are in this pull request. Otherwise, you could overwrite changes from other people. +10. Scroll to the bottom of the page, making sure that only your changed files are in this pull request. Otherwise, you could overwrite changes from other people. -10. Click **Create pull request**. +11. Click **Create pull request**. The pull request is sent to the writer of the topic and your edits are reviewed. If your request is accepted, updates are published to one of the following places: diff --git a/windows/whats-new/contribute-to-a-topic.md b/windows/whats-new/contribute-to-a-topic.md index 02acdf8d59..79d0a7fd24 100644 --- a/windows/whats-new/contribute-to-a-topic.md +++ b/windows/whats-new/contribute-to-a-topic.md @@ -9,7 +9,7 @@ ms.sitesec: library # Edit an existing topic using the Contribute link -You can now make suggestions and update existing content with a simple click of a link. +You can now make suggestions and update existing, public content with a GitHub account and a simple click of a link. **To edit a topic** @@ -25,34 +25,34 @@ You can now make suggestions and update existing content with a simple click of ![GitHub Web, showing the Pencil icon in the red box](images/pencil-icon.png) -3. Using markdown language, make your changes to the topic. For info about how to edit content using markdown, see: +4. Using markdown language, make your changes to the topic. For info about how to edit content using markdown, see: - **If you're linked to the Microsoft organization in GitHub:** [Windows Open Publishing Guide Home](http://aka.ms/windows-op-guide) - **If you're external to Microsoft:** [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) -4. Make your suggested change, and then click **Preview Changes** to make sure it looks correct. +5. Make your suggested change, and then click **Preview Changes** to make sure it looks correct. ![GitHub Web, showing the Preview Changes tab](images/preview-changes.png) -5. When you’re done editing the topic, scroll to the bottom of the page, and then click **Propose file change** to create a fork in your personal GitHub account. +6. When you’re done editing the topic, scroll to the bottom of the page, and then click **Propose file change** to create a fork in your personal GitHub account. ![GitHub Web, showing the Propose file change button](images/propose-file-change.png) The **Comparing changes** screen appears to see what the changes are between your fork and the original content. -6. On the **Comparing changes** screen, you’ll see if there are any problems with the file you’re checking in. +7. On the **Comparing changes** screen, you’ll see if there are any problems with the file you’re checking in. If there are no problems, you’ll see the message, **Able to merge**. ![GitHub Web, showing the Comparing changes screen](images/compare-changes.png) -7. Click **Create pull request**. +8. Click **Create pull request**. -8. Enter a title and description to give the approver the appropriate context about what’s in the request. +9. Enter a title and description to give the approver the appropriate context about what’s in the request. -9. Scroll to the bottom of the page, making sure that only your changed files are in this pull request. Otherwise, you could overwrite changes from other people. +10. Scroll to the bottom of the page, making sure that only your changed files are in this pull request. Otherwise, you could overwrite changes from other people. -10. Click **Create pull request**. +11. Click **Create pull request**. The pull request is sent to the writer of the topic and your edits are reviewed. If your request is accepted, updates are published to one of the following places: