Skip to content

Commit 656350e

Browse files
oboukliColin Robertson
authored andcommitted
Clean up CONTRIBUTING.md (MicrosoftDocs#347)
* Clean up CONTRIBUTING.md * Update CONTRIBUTING.md - Minor tweaks.
1 parent d39bcf7 commit 656350e

1 file changed

Lines changed: 14 additions & 16 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ In this topic, you'll see the basic process for adding or updating content in th
77
In this topic, we'll cover:
88

99
* [Process for contributing](#process-for-contributing)
10-
* [Guidance checklist](#guidance-checklist)
10+
* [DOs and DON'Ts](#dos-and-donts)
1111
* [Building the docs](#building-the-docs)
1212
* [Contributing to samples](#contributing-to-samples)
13-
* [Contributor License Agreement](#contributor-license-agreement)
13+
* [Contributor license agreement](#contributor-license-agreement)
1414

1515
## Process for contributing
1616

@@ -19,7 +19,7 @@ The content inside the **docs** folder is organized into sections that are organ
1919

2020
You can skip this first step for small changes.
2121

22-
**Step 2:** Fork the `MicrosoftDocs/cpp-docs` repo.
22+
**Step 2:** Fork the `MicrosoftDocs/cpp-docs` repository.
2323

2424
**Step 3:** Create a `branch` for your article.
2525

@@ -30,17 +30,17 @@ If it's a new topic, you can use this [template file](./styleguide/template.md)
3030
Navigate to the folder that corresponds to the TOC location determined for your article in step 1.
3131
That folder contains the Markdown files for all articles in that section. If necessary, create a new folder to place the files for your content.
3232

33-
For images and other static resources, add them to the subfolder called **media**. If you are creating a new folder for content, add a media folder to the new folder.
33+
For images and other static resources, add them to the subfolder called `media`. If you are creating a new folder for content, add a media folder to the new folder.
3434

3535
Be sure to follow the proper Markdown syntax. See the [style guide](./styleguide/template.md) for more information.
3636

3737
### Example structure
3838

3939
docs
40-
/standard-library
41-
wstring-convert-class.md
42-
/media
43-
wstring-conversion.png
40+
/standard-library
41+
wstring-convert-class.md
42+
/media
43+
wstring-conversion.png
4444

4545
**Step 5:** Submit a Pull Request (PR) from your branch to `MicrosoftDocs/cpp-docs/master`.
4646

@@ -70,30 +70,28 @@ Below is a short list of guiding rules that you should keep in mind when you are
7070
7171
## Building the docs
7272

73-
The documentation is written in [GitHub Flavored Markdown](https://help.github.com/categories/writing-on-github/) and built using [DocFX](http://dotnet.github.io/docfx/) and other internal publishing/building tools. It is hosted at [docs.microsoft.com](https://docs.microsoft.com/).
73+
The documentation is written in [GitHub Flavored Markdown](https://help.github.com/categories/writing-on-github/) and built using [DocFX](https://dotnet.github.io/docfx/) and other internal publishing/building tools. It is hosted at [docs.microsoft.com](https://docs.microsoft.com/).
7474

7575
If you want to build the docs locally, you need to install [DocFX](https://dotnet.github.io/docfx/); latest versions are the best.
7676

77-
There are several ways to use DocFX, and most of them are covered in the [DocFX getting started guide](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html).
78-
The following instructions use the [command-line based](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool) version of the tool.
79-
If you are comfortable with other ways listed on the link above, feel free to use those.
77+
There are several ways to use DocFX, and most of them are covered in the [DocFX getting started guide](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html). The following instructions use the [command-line based](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool) version of the tool. If you are comfortable with other ways listed on the link above, feel free to use those.
8078

8179
**Note:** Currently DocFX requires the .NET Framework on Windows or Mono (for Linux or macOS). We hope to port it to .NET Core in the future.
8280

8381
You can build and preview the resulting site locally using a built-in web server. Navigate to the `cpp-docs\docs` folder on your machine and type the following command:
8482

85-
`docfx -t default --serve`
83+
> docfx -t default --serve
8684
8785
This starts the local preview on [localhost:8080](http://localhost:8080). You can then view the changes by going to `http://localhost:8080/[path]`, such as `http://localhost:8080/cpp/visual-cpp-in-visual-studio.html`.
8886

8987
**Note:** the local preview currently doesn't contain any themes at the moment so the look and feel won't be the same as in the documentation site. We're working towards fixing that experience. We also use some custom extensions for embedded video, notes, and included documents, that won't be visible in the preview.
9088

9189
## Contributing to samples
9290

93-
For now, include required sample code as inline code blocks in your article. The repo has a codesnippets folder, but this is not ready for public contributions.
91+
For now, include required sample code as inline code blocks in your article. The repository has a `codesnippets` folder, but this is not ready for public contributions.
9492

9593
## Contributor license agreement
9694

97-
You must sign the [Contribution License Agreement (CLA)](LICENSE) before your PR is merged. This is a one-time requirement for projects in docs.microsoft.com. You can read more about [Contribution License Agreements (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) on Wikipedia.
95+
You must sign the [Contribution License Agreement (CLA)](LICENSE) before your PR is merged. This is a one-time requirement for projects in docs.microsoft.com. You can read more about [Contribution License Agreements (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) on Wikipedia.
9896

99-
You don't have to sign the agreement up-front. You can clone, fork, and submit your PR as usual. When your PR is created, it is classified by a CLA bot. If the change is trivial (for example, you fixed a typo), then the PR is labeled with cla-not-required. Otherwise, it's classified as cla-required. Once you signed the CLA, the current and all future pull requests are labeled as cla-signed.
97+
You don't have to sign the agreement up-front. You can clone, fork, and submit your PR as usual. When your PR is created, it is classified by a CLA bot. If the change is trivial (for example, you fixed a typo), then the PR is labeled with CLA-not-required. Otherwise, it's classified as CLA-required. Once you signed the CLA, the current and all future pull requests are labeled as CLA-signed.

0 commit comments

Comments
 (0)