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

Commit 28780d6

Browse files
committed
Review comments
1 parent f97a8a2 commit 28780d6

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,31 @@
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 (labeled "help wanted") by the TypeScript team.
5+
A bug must have an issue tracking it in the issue tracker that has been approved (Lable: "help wanted") by the TypeScript team.
66
Your pull request should include a link to the bug that you are fixing.
7-
If you've submitted a PR for a bug, please post a comment on the issue to avoid duplication of effort.
7+
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 "help wanted" by a TypeScript coordinator with the message "Approved") in the suggestion issue.
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.
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 new sample should:
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.
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.
1617

17-
* include a detailed `README.md` file describing how to setup, build, and run the sample.
18-
* include a `tsconfig.json`.
19-
* build against a publicly released version of the TypeScript toolset.
20-
* only include tools/technolgies that serve the main purpose of the sample (e.g. no test frameworks unless showcasing a test framework).
21-
* work across all platforms.
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.
21+
See [TypeScript quick start samples](https://github.com/Microsoft/TypeScript-Handbook/tree/master/pages/quick-start) for guidance.
22+
23+
A sample should be self-contained.
24+
[npm](https://www.npmjs.com/) is the recommended way of acquiring dependencies.
25+
[typings](https://github.com/typings/typings) is the recommended way of acquiring definition files.
26+
27+
A sample should be IDE/editor-friendly. Please include a `tsconfig.json` file at the root.
28+
29+
A sample should have no OS dependency.
2230

2331
## Legal
2432

@@ -28,5 +36,4 @@ Briefly, this agreement testifies that you are granting us permission to use the
2836
Please submit a Contributor License Agreement (CLA) before submitting a pull request.
2937
You may visit https://cla.microsoft.com to sign digitally.
3038
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]>.
31-
Be sure to include your github user name along with the agreement.
32-
Once we have received the signed CLA, we'll review the request.
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.

0 commit comments

Comments
 (0)