|
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. Your pull request should include a link to the bug that you are fixing. If you've submitted a PR for a bug, please post a comment in the bug to avoid duplication of effort. |
| 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 | +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. |
6 | 8 |
|
7 | 9 | ## Contributing new samples
|
8 | 10 |
|
9 |
| -New samples may be accepted, but will need to first be approved (marked as Lable: "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 "help wanted" by a TypeScript coordinator with the message "Approved") in the suggestion issue. |
10 | 12 |
|
11 | 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.
|
12 | 14 |
|
13 | 15 | A new sample should:
|
14 |
| -* Include a detailed `readme.md` file discribing how to setup, build and run |
15 |
| -* Build against a publiclly released version of the TypeScript toolset |
16 |
| -* Only include tools/technolgies that serve the main purpose of the sample |
17 |
| -* Work cross-platform |
| 16 | + |
| 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 | 22 |
|
19 | 23 | ## Legal
|
20 | 24 |
|
21 |
| -You will need to complete a Contributor License Agreement (CLA). Briefly, this agreement testifies that you are granting us permission to use the submitted change according to the terms of the project's license, and that the work being submitted is under appropriate copyright. |
| 25 | +You will need to complete a Contributor License Agreement (CLA). |
| 26 | +Briefly, this agreement testifies that you are granting us permission to use the submitted change according to the terms of the project's license, and that the work being submitted is under appropriate copyright. |
22 | 27 |
|
23 |
| -Please submit a Contributor License Agreement (CLA) before submitting a pull request. You may visit https://cla.microsoft.com to sign digitally. 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]>. Be sure to include your github user name along with the agreement. Once we have received the signed CLA, we'll review the request. |
| 28 | +Please submit a Contributor License Agreement (CLA) before submitting a pull request. |
| 29 | +You may visit https://cla.microsoft.com to sign digitally. |
| 30 | +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. |
0 commit comments