Skip to content

Commit 20c103b

Browse files
New Docs added for library usage guidance
1 parent fff5730 commit 20c103b

8 files changed

+490
-314
lines changed

CONTRIBUTING.md

+16-19
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,21 @@ Here are some ways you can contribute to this documentation:
2020

2121
## Contribute using GitHub
2222

23-
Use GitHub to contribute to this documentation without having to clone the repo to your desktop. This is the easiest way to create a pull request in this repository. Use this method to make a minor change that doesn't involve code changes.
23+
Use GitHub to contribute to this documentation without having to clone the repository to your desktop. This is the easiest way to create a pull request in this repository. Use this method to make a minor change that doesn't involve code changes.
2424

2525
**Note** Using this method allows you to contribute to one article at a time.
2626

2727
### To Contribute using GitHub
2828

29-
1. Find the article you want to contribute to on GitHub.
29+
1. Find the article you want to contribute to on GitHub.
3030

3131
If the article is in MSDN, choose the **suggest and submit changes** link in the **Contribute to this content** section and you'll be taken to the same article on GitHub.
3232
2. Once you are on the article in GitHub, sign in to GitHub (get a free account [Join GitHub](https://github.com/join).
33-
3. Choose the **pencil icon** (edit the file in your fork of this project) and make your changes in the **<>Edit file** window.
33+
3. Choose the **pencil icon** (edit the file in your fork of this project) and make your changes in the **<>Edit file** window.
3434
4. Scroll to the bottom and enter a description.
3535
5. Choose **Propose file change**>**Create pull request**.
3636

37-
You now have successfully submitted a pull request. Pull requests are typically reviewed within 10 business days.
38-
37+
You now have successfully submitted a pull request. Pull requests are typically reviewed within 10 business days.
3938

4039
## Contribute using Git
4140

@@ -48,7 +47,7 @@ Use Git to contribute substantive changes, such as:
4847

4948
### To Contribute using Git
5049

51-
1. If you don't have a GitHub account, set one up at [GitHub](https://github.com/join).
50+
1. If you don't have a GitHub account, set one up at [GitHub](https://github.com/join).
5251
2. After you have an account, install Git on your computer. Follow the steps in [Setting up Git Tutorial](https://help.github.com/articles/set-up-git/).
5352
3. To submit a pull request using Git, follow the steps in [Use GitHub, Git, and this repository](#use-github-git-and-this-repository).
5453
4. You will be asked to sign the Contributor's License Agreement if you are:
@@ -68,10 +67,10 @@ Pull requests are typically reviewed within 10 business days.
6867

6968
### To set up your fork of the repository
7069

71-
1. Set up a GitHub account so you can contribute to this project. If you haven't done this, go to [GitHub](https://github.com/join) and do it now.
72-
2. Install Git on your computer. Follow the steps in the [Setting up Git Tutorial] [Set Up Git].
73-
3. Create your own fork of this repository. To do this, at the top of the page, choose the **Fork** button.
74-
4. Copy your fork to your computer. To do this, open Git Bash. At the command prompt enter:
70+
1. Set up a GitHub account so you can contribute to this project. If you haven't done this, go to [GitHub](https://github.com/join) and do it now.
71+
2. Install Git on your computer. Follow the steps in the [Setting up Git Tutorial] [Set Up Git].
72+
3. Create your own fork of this repository. To do this, at the top of the page, choose the **Fork** button.
73+
4. Copy your fork to your computer. To do this, open Git Bash. At the command prompt enter:
7574

7675
git clone https://github.com/<your user name>/<repo name>.git
7776

@@ -162,9 +161,9 @@ Once your changes are successfully merged into the main repository, delete the b
162161

163162
#### To delete a branch
164163

165-
1. In the Git Bash command prompt, type `git checkout master`. This ensures that you aren't in the branch to be deleted (which isn't allowed).
166-
2. Next, at the command prompt, type `git branch -d <branch name>`. This deletes the branch on your computer only if it has been successfully merged to the upstream repository. (You can override this behavior with the `–D` flag, but first be sure you want to do this.)
167-
3. Finally, type `git push origin :<branch name>` at the command prompt (a space before the colon and no space after it). This will delete the branch on your github fork.
164+
1. In the Git Bash command prompt, type `git checkout master`. This ensures that you aren't in the branch to be deleted (which isn't allowed).
165+
2. Next, at the command prompt, type `git branch -d <branch name>`. This deletes the branch on your computer only if it has been successfully merged to the upstream repository. (You can override this behavior with the `–D` flag, but first be sure you want to do this.)
166+
3. Finally, type `git push origin :<branch name>` at the command prompt (a space before the colon and no space after it). This will delete the branch on your github fork.
168167

169168
Congratulations, you have successfully contributed to the project!
170169

@@ -174,18 +173,17 @@ Congratulations, you have successfully contributed to the project!
174173

175174
The [markdown template](/articles/0-markdown-template-for-new-articles.md) contains the basic Markdown for a topic that includes a table of contents, sections with subheadings, links to other Office developer topics, links to other sites, bold text, italic text, numbered and bulleted lists, code snippets, and images.
176175

177-
178176
### Standard Markdown
179177

180178
All of the articles in this repository use Markdown. A complete introduction (and listing of all the syntax) can be found at [Markdown Home] [].
181-
179+
182180
## FAQ
183181

184182
### How do I get a GitHub account?
185183

186184
Fill out the form at [Join GitHub](https://github.com/join) to open a free GitHub account.
187185

188-
### Where do I get a Contributor's License Agreement?
186+
### Where do I get a Contributor's License Agreement?
189187

190188
You will automatically be sent a notice that you need to sign the Contributor's License Agreement (CLA) if your pull request requires one.
191189

@@ -194,7 +192,7 @@ As a community member, **you must sign the Contribution License Agreement (CLA)
194192
### What happens with my contributions?
195193

196194
When you submit your changes, via a pull request, our team will be notified and will review your pull request. You will receive notifications about your pull request from GitHub; you may also be notified by someone from our team if we need more information. We reserve the right to edit your submission for legal, style, clarity, or other issues.
197-
195+
198196
### Can I become an approver for this repository's GitHub pull requests?
199197

200198
Currently, we are not allowing external contributors to approve pull requests in this repository.
@@ -212,5 +210,4 @@ We typically review pull requests and respond to issues within 10 business days.
212210
[GitHub Help]: http://help.github.com/
213211
[Set Up Git]: http://help.github.com/win-set-up-git/
214212
[Markdown Home]: http://daringfireball.net/projects/markdown/
215-
[Daring Fireball]: http://daringfireball.net/
216-
213+
[Daring Fireball]: http://daringfireball.net/

0 commit comments

Comments
 (0)