Skip to content
This repository was archived by the owner on Oct 12, 2022. It is now read-only.

Commit 5fb0f81

Browse files
Update CONTRIBUTING.md
1 parent 28780d6 commit 5fb0f81

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,23 @@
22

33
## Contributing fixes to existing samples
44

5-
A bug must have an issue tracking it in the issue tracker that has been approved (Lable: "help wanted") by the TypeScript team.
5+
A bug must have an issue tracking it in the issue tracker that has been approved (labeled "help wanted") by the TypeScript team.
66
Your pull request should include a link to the bug that you are fixing.
77
If you've submitted a PR for a bug, please post a comment in the bug to avoid duplication of effort.
88

99
## Contributing new samples
1010

11-
New samples may be accepted, but will need to first be approved (marked as Label: "help wanted" by a TypeScript coordinator) in the suggestion issue.
11+
New samples may be accepted, but will need to first be approved (labeled "help wanted" by a TypeScript coordinator) in the suggestion issue.
1212

1313
For new samples, please provide a detailed explanation of the intended sample, list of technologies or tools used, and an explanation of why existing samples are not sufficient and a new sample is needed.
1414

15-
A sample is meant to showcase a specific technology or toolchain integration with TypeScript; a sample is not meant to be a template that users would use to get a project going.
15+
A sample is meant to showcase a specific technology or toolchain integration with TypeScript; it is not meant to be a template that users would use to get a project going.
1616
A sample should only include tools/technologies that serve the main technology it covers; for instance, a sample for a UI framework should not include a test framework integration.
1717

1818
A sample should be well documented.
19-
Please include comments in `readme.md` explaining why steps are being taken, including in build files if applicable.
20-
A good sample `readme.md` should read like a walkthrough, guiding the reader through different steps of setting up and building the sample.
19+
Please include comments in code as well as content in the a `README.md` explaining why steps are being taken.
20+
Comments should also be included in build files if applicable.
21+
A good sample `README.md` should read like a walkthrough, guiding the reader through different steps of setting up and building the sample.
2122
See [TypeScript quick start samples](https://github.com/Microsoft/TypeScript-Handbook/tree/master/pages/quick-start) for guidance.
2223

2324
A sample should be self-contained.
@@ -36,4 +37,4 @@ Briefly, this agreement testifies that you are granting us permission to use the
3637
Please submit a Contributor License Agreement (CLA) before submitting a pull request.
3738
You may visit https://cla.microsoft.com to sign digitally.
3839
Alternatively, download the agreement ([Microsoft Contribution License Agreement.docx](https://www.codeplex.com/Download?ProjectName=typescript&DownloadId=822190) or [Microsoft Contribution License Agreement.pdf](https://www.codeplex.com/Download?ProjectName=typescript&DownloadId=921298)), sign, scan, and email it back to <[email protected]>.
39-
Be sure to include your github user name along with the agreement. Once we have received the signed CLA, we'll review the request.
40+
Be sure to include your GitHub user name along with the agreement. Once we have received the signed CLA, we'll review the request.

0 commit comments

Comments
 (0)