You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 12, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,22 +2,23 @@
2
2
3
3
## Contributing fixes to existing samples
4
4
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.
6
6
Your pull request should include a link to the bug that you are fixing.
7
7
If you've submitted a PR for a bug, please post a comment in the bug to avoid duplication of effort.
8
8
9
9
## Contributing new samples
10
10
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.
12
12
13
13
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.
14
14
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.
16
16
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.
17
17
18
18
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.
21
22
See [TypeScript quick start samples](https://github.com/Microsoft/TypeScript-Handbook/tree/master/pages/quick-start) for guidance.
22
23
23
24
A sample should be self-contained.
@@ -36,4 +37,4 @@ Briefly, this agreement testifies that you are granting us permission to use the
36
37
Please submit a Contributor License Agreement (CLA) before submitting a pull request.
37
38
You may visit https://cla.microsoft.com to sign digitally.
38
39
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