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

Commit 202420c

Browse files
committed
Merge pull request #80 from Microsoft/contributingChanges
Contributing.md changes
2 parents 9bac00f + 5fb0f81 commit 202420c

File tree

1 file changed

+35
-4
lines changed

1 file changed

+35
-4
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,40 @@
11
## Contributing
2-
TypeScript is currently accepting contributions in the form of bug fixes. A bug must have an issue tracking it in the issue tracker that has been approved ("Milestone == Community") 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.
32

4-
New samples will not be accepted at this time.
3+
## Contributing fixes to existing samples
4+
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 in the bug to avoid duplication of effort.
8+
9+
## Contributing new samples
10+
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+
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+
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+
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+
18+
A sample should be well documented.
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.
22+
See [TypeScript quick start samples](https://github.com/Microsoft/TypeScript-Handbook/tree/master/pages/quick-start) for guidance.
23+
24+
A sample should be self-contained.
25+
[npm](https://www.npmjs.com/) is the recommended way of acquiring dependencies.
26+
[typings](https://github.com/typings/typings) is the recommended way of acquiring definition files.
27+
28+
A sample should be IDE/editor-friendly. Please include a `tsconfig.json` file at the root.
29+
30+
A sample should have no OS dependency.
531

632
## Legal
7-
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.
833

9-
Please submit a Contributor License Agreement (CLA) before submitting a pull request. Download the agreement ([Microsoft Contribution License Agreement.docx](https://www.codeplex.com/Download?ProjectName=typescript&DownloadId=822190)), 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. Please note that we’re currently only accepting pull requests of bug fixes rather than new features.
34+
You will need to complete a Contributor License Agreement (CLA).
35+
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.
36+
37+
Please submit a Contributor License Agreement (CLA) before submitting a pull request.
38+
You may visit https://cla.microsoft.com to sign digitally.
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]>.
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)