Skip to content

Commit 245e93c

Browse files
ghogenghogen
committed
Add contributing guide and readme.
1 parent e9d9394 commit 245e93c

2 files changed

Lines changed: 109 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to the Visual C++ documentation!
4+
5+
In this topic, you'll see the basic process for adding or updating content in the [Visual C++ documentation site](https://docs.microsoft.com/cpp-docs).
6+
7+
In this topic, we'll cover:
8+
9+
* [Process for contributing](#process-for-contributing)
10+
* [Guidance checklist](#guidance-checklist)
11+
* [Building the docs](#building-the-docs)
12+
* [Contributing to samples](#contributing-to-samples)
13+
* [Contributor License Agreement](#contributor-license-agreement)
14+
15+
## Process for contributing
16+
17+
**Step 1:** Open an issue describing the article you wish to write and how it relates to existing content.
18+
The content inside the **docs** folder is organized into sections that are organized by content area (e.g., debugger). Try to determine the correct folder for your new content. Get feedback on your proposal.
19+
20+
You can skip this first step for small changes.
21+
22+
**Step 2:** Fork the `Microsoft/cpp-docs` repo.
23+
24+
**Step 3:** Create a `branch` for your article.
25+
26+
**Step 4:** Write your article.
27+
28+
If it's a new topic, you can use this [template file](./styleguide/template.md) as your starting point. It contains the writing guidelines and also explains the metadata required for each article, such as author information.
29+
30+
Navigate to the folder that corresponds to the TOC location determined for your article in step 1.
31+
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.
32+
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.
34+
35+
Be sure to follow the proper Markdown syntax. See the [style guide](./styleguide/template.md) for more information.
36+
37+
### Example structure
38+
39+
docs
40+
/standard-library
41+
wstring-convert-class.md
42+
/media
43+
wstring-conversion.png
44+
45+
**Step 5:** Submit a Pull Request (PR) from your branch to `Microsoft/cpp-docs/master`.
46+
47+
If your PR is addressing an existing issue, add the `Fixes #Issue_Number` keyword to the commit message or PR description, so the issue can be automatically closed when the PR is merged. For more information, see [Closing issues via commit messages](https://help.github.com/articles/closing-issues-via-commit-messages/).
48+
49+
The Visual Studio team will review your PR and let you know if the change looks good or if there are any other updates/changes necessary in order to approve it.
50+
51+
**Step 6:** Make any necessary updates to your branch as discussed with the team.
52+
53+
The maintainers will merge your PR into the master branch once feedback has been applied and your change looks good.
54+
55+
On a certain cadence, we push all commits from master branch into the live branch and then you'll be able to see your contribution live at https://docs.microsoft.com/cpp-docs/.
56+
57+
## DOs and DON'Ts
58+
59+
Below is a short list of guiding rules that you should keep in mind when you are contributing to the .NET documentation.
60+
61+
- **DON'T** surprise us with big pull requests. Instead, file an issue and start a discussion so we can agree on a direction before you invest a large amount of time.
62+
- **DO** read the [style guide](./styleguide/template.md) and [voice and tone](./styleguide/voice-tone.md) guidelines.
63+
- **DO** use the [template](./styleguide/template.md) file as the starting point of your work.
64+
- **DO** create a separate branch on your fork before working on the articles.
65+
- **DO** follow the [GitHub Flow workflow](https://guides.github.com/introduction/flow/).
66+
- **DO** blog and tweet (or whatever) about your contributions, frequently!
67+
68+
> [!NOTE]
69+
> You might notice that some of the topics are not currently following all the guidelines specified here and on the [style guide](./styleguide/template.md) as well. We're working towards achieving consistency throughout the site. Check the list of [open issues](https://github.com/dotnet/docs/issues?q=is%3Aissue+is%3Aopen+label%3Aguidelines-adherence) we're currently tracking for that specific goal.
70+
71+
## Building the docs
72+
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/dotnet).
74+
75+
If you want to build the docs locally, you need to install [DocFX](https://dotnet.github.io/docfx/); latest versions are the best.
76+
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.
80+
81+
**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.
82+
83+
You can build and preview the resulting site locally using a built-in web server. Navigate to the core-docs folder on your machine and type the following command:
84+
85+
```
86+
docfx -t default --serve
87+
```
88+
89+
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/articles/welcome.html.
90+
91+
**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.
92+
93+
# Contributing to samples
94+
95+
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.

‎README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Visual Studio 2017 RC documentation for Visual C++
2+
3+
Welcome! This repo contains source files for the work-in-progress Visual C++ RC technical documentation. The topics are published on the [Visual Studio documentation site](https://docs.microsoft.com/cpp-docs).
4+
5+
The documentation for Visual Basic and Visual C# are located in a separate repo at [http://github.com/dotnet/core-docs](http://github.com/dotnet/core-docs), and the Visual C++ documentation is located in the repo located at [http://github.com/Microsoft/cpp-docs](http://github.com/Microsoft/cpp-docs).
6+
7+
## Contributing to the documentation
8+
9+
To contribute to this documentation, please see the [Contributing guide](CONTRIBUTING.md).
10+
We welcome your contributions to help us improve the Visual Studio docs. All the articles in this repository use GitHub flavored markdown.
11+
12+
Several feature areas of Visual Studio have their own folders in this repo, such as **debugger** for topics on debugging, **ide** for topics on the Visual Studio interactive development environment (IDE), and so forth. The **/media** subfolder in each folder contains art files for the topics. The [Contributing guide](CONTRIBUTING.md) has more information.
13+
14+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

0 commit comments

Comments
 (0)