From 17def55674daed3adb7e756fd0232ba6ae690e65 Mon Sep 17 00:00:00 2001 From: Mohamed Hegazy Date: Fri, 18 Mar 2016 12:12:04 -0700 Subject: [PATCH 1/4] Contributing.md changes --- CONTRIBUTING.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a656bec..15374e2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,23 @@ ## Contributing -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. -New samples will not be accepted at this time. +## Contributing fixes to existing samples + +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. + +## Contributing new samples + +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. + +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. + +A new sample should: +* Include a detailed `readme.md` file discribing how to setup, build and run +* Build against a publiclly released version of the TypeScript toolset +* Only include tools/technolgies that serve the main purpose of the sample +* Work cross-platform ## Legal -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. -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 . 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. \ No newline at end of file +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. + +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 . Be sure to include your github user name along with the agreement. Once we have received the signed CLA, we'll review the request. From f97a8a2b2cf90cf112ea69eafa9d531c723baff2 Mon Sep 17 00:00:00 2001 From: Daniel Rosenwasser Date: Fri, 18 Mar 2016 12:31:13 -0700 Subject: [PATCH 2/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15374e2..4e7b509 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,22 +2,31 @@ ## Contributing fixes to existing samples -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. +A bug must have an issue tracking it in the issue tracker that has been approved (labeled "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 on the issue to avoid duplication of effort. ## Contributing new samples -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. +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. 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. A new sample should: -* Include a detailed `readme.md` file discribing how to setup, build and run -* Build against a publiclly released version of the TypeScript toolset -* Only include tools/technolgies that serve the main purpose of the sample -* Work cross-platform + +* include a detailed `README.md` file describing how to setup, build, and run the sample. +* include a `tsconfig.json`. +* build against a publicly released version of the TypeScript toolset. +* only include tools/technolgies that serve the main purpose of the sample (e.g. no test frameworks unless showcasing a test framework). +* work across all platforms. ## Legal -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. +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. -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 . 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 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 . +Be sure to include your github user name along with the agreement. +Once we have received the signed CLA, we'll review the request. From 28780d604f41995da8c14c791552f090fdec2f35 Mon Sep 17 00:00:00 2001 From: Mohamed Hegazy Date: Fri, 18 Mar 2016 13:07:16 -0700 Subject: [PATCH 3/4] Review comments --- CONTRIBUTING.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4e7b509..515f405 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,23 +2,31 @@ ## Contributing fixes to existing samples -A bug must have an issue tracking it in the issue tracker that has been approved (labeled "help wanted") by the TypeScript team. +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 on the issue to avoid duplication of effort. +If you've submitted a PR for a bug, please post a comment in the bug to avoid duplication of effort. ## Contributing new samples -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. +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. 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. -A new sample should: +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. +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. -* include a detailed `README.md` file describing how to setup, build, and run the sample. -* include a `tsconfig.json`. -* build against a publicly released version of the TypeScript toolset. -* only include tools/technolgies that serve the main purpose of the sample (e.g. no test frameworks unless showcasing a test framework). -* work across all platforms. +A sample should be well documented. +Please include comments in `readme.md` explaining why steps are being taken, including in build files if applicable. +A good sample `readme.md` should read like a walkthrough, guiding the reader through different steps of setting up and building the sample. +See [TypeScript quick start samples](https://github.com/Microsoft/TypeScript-Handbook/tree/master/pages/quick-start) for guidance. + +A sample should be self-contained. +[npm](https://www.npmjs.com/) is the recommended way of acquiring dependencies. +[typings](https://github.com/typings/typings) is the recommended way of acquiring definition files. + +A sample should be IDE/editor-friendly. Please include a `tsconfig.json` file at the root. + +A sample should have no OS dependency. ## Legal @@ -28,5 +36,4 @@ Briefly, this agreement testifies that you are granting us permission to use the 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 . -Be sure to include your github user name along with the agreement. -Once we have received the signed CLA, we'll review the request. +Be sure to include your github user name along with the agreement. Once we have received the signed CLA, we'll review the request. From 5fb0f810a58eea35dafc3edf03557c438e4fccb2 Mon Sep 17 00:00:00 2001 From: Daniel Rosenwasser Date: Fri, 18 Mar 2016 13:11:50 -0700 Subject: [PATCH 4/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 515f405..0305bd6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,22 +2,23 @@ ## Contributing fixes to existing samples -A bug must have an issue tracking it in the issue tracker that has been approved (Lable: "help wanted") by the TypeScript team. +A bug must have an issue tracking it in the issue tracker that has been approved (labeled "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. ## Contributing new samples -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. +New samples may be accepted, but will need to first be approved (labeled "help wanted" by a TypeScript coordinator) in the suggestion issue. 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. -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. +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. 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. A sample should be well documented. -Please include comments in `readme.md` explaining why steps are being taken, including in build files if applicable. -A good sample `readme.md` should read like a walkthrough, guiding the reader through different steps of setting up and building the sample. +Please include comments in code as well as content in the a `README.md` explaining why steps are being taken. +Comments should also be included in build files if applicable. +A good sample `README.md` should read like a walkthrough, guiding the reader through different steps of setting up and building the sample. See [TypeScript quick start samples](https://github.com/Microsoft/TypeScript-Handbook/tree/master/pages/quick-start) for guidance. A sample should be self-contained. @@ -36,4 +37,4 @@ Briefly, this agreement testifies that you are granting us permission to use the 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 . -Be sure to include your github user name along with the agreement. Once we have received the signed CLA, we'll review the request. +Be sure to include your GitHub user name along with the agreement. Once we have received the signed CLA, we'll review the request.