From 04845ccb039fda23201d5071202c78b3917ad14d Mon Sep 17 00:00:00 2001 From: Phillip Hoff Date: Fri, 7 Feb 2020 16:01:55 -0800 Subject: [PATCH] Updates to docs based on corporate governance requirements (#10) * Update docs per CG guidelines. * Add copyright headers to source files. * Scaffold NOTICE file. --- .eslintrc.js | 3 +++ CODE_OF_CONDUCT.md | 9 -------- CONTRIBUTING.md | 14 +++++++++++ LICENSE | 21 ----------------- LICENSE.txt | 23 +++++++++++++++++++ NOTICE.html | 2 ++ PRIVACY | 1 + README.md | 22 ++++++++++-------- .../Controllers/AccountsController.cs | 6 ++--- samples/dotnetcore/Program.cs | 6 ++--- samples/dotnetcore/Startup.cs | 6 ++--- src/commands/scaffoldDaprTasks.ts | 3 +++ src/ext.ts | 3 +++ src/extension.ts | 3 +++ src/scaffolding/configurationScaffolder.ts | 3 +++ src/scaffolding/daprComponentScaffolder.ts | 3 +++ src/scaffolding/taskScaffolder.ts | 3 +++ src/scaffolding/templateScaffolder.ts | 3 +++ src/tasks/commandTaskProvider.ts | 3 +++ src/tasks/customExecutionTaskProvider.ts | 3 +++ src/tasks/daprCommandTaskProvider.ts | 3 +++ src/tasks/daprdCommandTaskProvider.ts | 3 +++ src/tasks/daprdDownTaskProvider.ts | 3 +++ src/tasks/taskDefinition.ts | 3 +++ src/tasks/taskPseudoterminal.ts | 3 +++ src/tasks/taskPseudoterminalWriter.ts | 3 +++ src/test/runTest.ts | 3 +++ src/test/suite/extension.test.ts | 3 +++ src/test/suite/index.ts | 3 +++ src/util/commandLineBuilder.ts | 6 ++--- src/util/process.ts | 6 ++--- src/util/timer.ts | 3 +++ 32 files changed, 123 insertions(+), 59 deletions(-) delete mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md delete mode 100644 LICENSE create mode 100644 LICENSE.txt create mode 100644 NOTICE.html create mode 100644 PRIVACY diff --git a/.eslintrc.js b/.eslintrc.js index 9893cec..536490a 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + module.exports = { env: { es6: true, diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index c72a574..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,9 +0,0 @@ -# Microsoft Open Source Code of Conduct - -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). - -Resources: - -- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/) -- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) -- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c282e9a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contributing + +This project welcomes contributions and suggestions. Most contributions require you to +agree to a Contributor License Agreement (CLA) declaring that you have the right to, +and actually do, grant us the rights to use your contribution. For details, visit +https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether you need +to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the +instructions provided by the bot. You will only need to do this once across all repositories using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) +or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 3d8b93b..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ - MIT License - - Copyright (c) Microsoft Corporation. - - Permission is hereby granted, free of charge, to any person obtaining a copy - of this software and associated documentation files (the "Software"), to deal - in the Software without restriction, including without limitation the rights - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - SOFTWARE diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..0c7eb52 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,23 @@ +Dapr Extension for Visual Studio Code + +Copyright (c) Microsoft Corporation. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/NOTICE.html b/NOTICE.html new file mode 100644 index 0000000..754b3bf --- /dev/null +++ b/NOTICE.html @@ -0,0 +1,2 @@ + +NOTICES AND INFORMATION

NOTICES AND INFORMATION

Do Not Translate or Localize

This software incorporates material from third parties. Microsoft makes certain open source code available at https://3rdpartysource.microsoft.com, or you may send a check or money order for US $5.00, including the product name, the open source component name, platform, and version number, to:

Source Code Compliance Team
Microsoft Corporation
One Microsoft Way
Redmond, WA 98052
USA

Notwithstanding any other terms, you may reverse engineer this software to the extent required to debug changes to any libraries licensed under the GNU Lesser General Public License.

    \ No newline at end of file diff --git a/PRIVACY b/PRIVACY new file mode 100644 index 0000000..3817a30 --- /dev/null +++ b/PRIVACY @@ -0,0 +1 @@ +Data Collection. The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices. \ No newline at end of file diff --git a/README.md b/README.md index 6d93327..05ce4e9 100644 --- a/README.md +++ b/README.md @@ -64,16 +64,20 @@ Added features X, Y, and Z. **Enjoy!** -# Contributing +## Telemetry -This project welcomes contributions and suggestions. Most contributions require you to agree to a -Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us -the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. +### Data Collection -When you submit a pull request, a CLA bot will automatically determine whether you need to provide -a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions -provided by the bot. You will only need to do this once across all repos using our CLA. +The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices. + +### Disabling Telemetry + +If you don’t wish to send usage data to Microsoft, you can set the `telemetry.enableTelemetry` setting to `false`. Learn more in our [FAQ](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting). + +## Microsoft Open Source Code of Conduct This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). -For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or -contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + +## License + +[MIT](LICENSE.txt) diff --git a/samples/dotnetcore/Controllers/AccountsController.cs b/samples/dotnetcore/Controllers/AccountsController.cs index e487967..a02b7a0 100644 --- a/samples/dotnetcore/Controllers/AccountsController.cs +++ b/samples/dotnetcore/Controllers/AccountsController.cs @@ -1,7 +1,5 @@ -/*------------------------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information. - *-------------------------------------------------------------------------------------------------------------*/ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. using System.Threading.Tasks; using Dapr; diff --git a/samples/dotnetcore/Program.cs b/samples/dotnetcore/Program.cs index 7cf1980..a4dfa12 100644 --- a/samples/dotnetcore/Program.cs +++ b/samples/dotnetcore/Program.cs @@ -1,7 +1,5 @@ -/*------------------------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information. - *-------------------------------------------------------------------------------------------------------------*/ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. using Microsoft.AspNetCore.Hosting; using Microsoft.AspNetCore.Builder; diff --git a/samples/dotnetcore/Startup.cs b/samples/dotnetcore/Startup.cs index 825eb96..dfea8e7 100644 --- a/samples/dotnetcore/Startup.cs +++ b/samples/dotnetcore/Startup.cs @@ -1,7 +1,5 @@ -/*------------------------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information. - *-------------------------------------------------------------------------------------------------------------*/ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; diff --git a/src/commands/scaffoldDaprTasks.ts b/src/commands/scaffoldDaprTasks.ts index b7b7c50..530a8cd 100644 --- a/src/commands/scaffoldDaprTasks.ts +++ b/src/commands/scaffoldDaprTasks.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import * as fse from 'fs-extra'; import * as path from 'path'; import * as vscode from 'vscode'; diff --git a/src/ext.ts b/src/ext.ts index e43b9e6..99af1a3 100644 --- a/src/ext.ts +++ b/src/ext.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import { UIExtensionVariables } from "vscode-azureextensionui"; const ext = {} as UIExtensionVariables; diff --git a/src/extension.ts b/src/extension.ts index dfac7e5..7d279d9 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + // The module 'vscode' contains the VS Code extensibility API // Import the module and reference it with the alias vscode in your code below import * as vscode from 'vscode'; diff --git a/src/scaffolding/configurationScaffolder.ts b/src/scaffolding/configurationScaffolder.ts index 4266ea2..31f4e1b 100644 --- a/src/scaffolding/configurationScaffolder.ts +++ b/src/scaffolding/configurationScaffolder.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import * as vscode from 'vscode'; export interface DebugConfiguration extends vscode.DebugConfiguration { diff --git a/src/scaffolding/daprComponentScaffolder.ts b/src/scaffolding/daprComponentScaffolder.ts index 63a1bd3..acb2810 100644 --- a/src/scaffolding/daprComponentScaffolder.ts +++ b/src/scaffolding/daprComponentScaffolder.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import * as fse from 'fs-extra'; import * as path from 'path'; import * as process from 'process'; diff --git a/src/scaffolding/taskScaffolder.ts b/src/scaffolding/taskScaffolder.ts index 920cc2d..ed23fa2 100644 --- a/src/scaffolding/taskScaffolder.ts +++ b/src/scaffolding/taskScaffolder.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import * as vscode from 'vscode'; import { TaskDefinition } from '../tasks/taskDefinition'; diff --git a/src/scaffolding/templateScaffolder.ts b/src/scaffolding/templateScaffolder.ts index 2d8cfa1..ba65c90 100644 --- a/src/scaffolding/templateScaffolder.ts +++ b/src/scaffolding/templateScaffolder.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import * as fse from 'fs-extra'; import * as handlebars from 'handlebars'; import * as path from 'path'; diff --git a/src/tasks/commandTaskProvider.ts b/src/tasks/commandTaskProvider.ts index 337fccd..9a22309 100644 --- a/src/tasks/commandTaskProvider.ts +++ b/src/tasks/commandTaskProvider.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import * as cp from 'child_process'; import * as vscode from 'vscode'; import CustomExecutionTaskProvider from "./customExecutionTaskProvider"; diff --git a/src/tasks/customExecutionTaskProvider.ts b/src/tasks/customExecutionTaskProvider.ts index 2b9cac0..8240f42 100644 --- a/src/tasks/customExecutionTaskProvider.ts +++ b/src/tasks/customExecutionTaskProvider.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import * as vscode from 'vscode'; import TaskPseudoterminal from './taskPseudoterminal'; import { PseudoterminalWriter } from './taskPseudoterminalWriter'; diff --git a/src/tasks/daprCommandTaskProvider.ts b/src/tasks/daprCommandTaskProvider.ts index 5145532..23ac24d 100644 --- a/src/tasks/daprCommandTaskProvider.ts +++ b/src/tasks/daprCommandTaskProvider.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import CommandLineBuilder from '../util/commandLineBuilder'; import CommandTaskProvider from './commandTaskProvider'; import { TaskDefinition } from './taskDefinition'; diff --git a/src/tasks/daprdCommandTaskProvider.ts b/src/tasks/daprdCommandTaskProvider.ts index 1e04f42..f9b7b82 100644 --- a/src/tasks/daprdCommandTaskProvider.ts +++ b/src/tasks/daprdCommandTaskProvider.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import CommandLineBuilder from '../util/commandLineBuilder'; import CommandTaskProvider from './commandTaskProvider'; import { TaskDefinition } from './taskDefinition'; diff --git a/src/tasks/daprdDownTaskProvider.ts b/src/tasks/daprdDownTaskProvider.ts index 588539e..7a81932 100644 --- a/src/tasks/daprdDownTaskProvider.ts +++ b/src/tasks/daprdDownTaskProvider.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import * as psList from 'ps-list'; import CustomExecutionTaskProvider from "./customExecutionTaskProvider"; import { TaskDefinition } from './taskDefinition'; diff --git a/src/tasks/taskDefinition.ts b/src/tasks/taskDefinition.ts index 1fb618f..c571b5a 100644 --- a/src/tasks/taskDefinition.ts +++ b/src/tasks/taskDefinition.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import * as vscode from 'vscode'; export interface DependsOn { diff --git a/src/tasks/taskPseudoterminal.ts b/src/tasks/taskPseudoterminal.ts index f1e0982..79862da 100644 --- a/src/tasks/taskPseudoterminal.ts +++ b/src/tasks/taskPseudoterminal.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import * as vscode from 'vscode'; import TaskPseudoterminalWriter, { PseudoterminalWriter } from './taskPseudoterminalWriter'; diff --git a/src/tasks/taskPseudoterminalWriter.ts b/src/tasks/taskPseudoterminalWriter.ts index 1023109..9788ae7 100644 --- a/src/tasks/taskPseudoterminalWriter.ts +++ b/src/tasks/taskPseudoterminalWriter.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + export interface PseudoterminalWriter { write(output: string): void; writeLine(output: string): void; diff --git a/src/test/runTest.ts b/src/test/runTest.ts index 95fe978..cc97972 100644 --- a/src/test/runTest.ts +++ b/src/test/runTest.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import * as path from 'path'; import { runTests } from 'vscode-test'; diff --git a/src/test/suite/extension.test.ts b/src/test/suite/extension.test.ts index d59ba91..43a572b 100644 --- a/src/test/suite/extension.test.ts +++ b/src/test/suite/extension.test.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import * as assert from 'assert'; // You can import and use all API from the 'vscode' module diff --git a/src/test/suite/index.ts b/src/test/suite/index.ts index 2cd152c..19e67aa 100644 --- a/src/test/suite/index.ts +++ b/src/test/suite/index.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + import * as path from 'path'; import * as Mocha from 'mocha'; import * as glob from 'glob'; diff --git a/src/util/commandLineBuilder.ts b/src/util/commandLineBuilder.ts index e4b2c2b..393c8b4 100644 --- a/src/util/commandLineBuilder.ts +++ b/src/util/commandLineBuilder.ts @@ -1,7 +1,5 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See LICENSE.md in the project root for license information. - *--------------------------------------------------------------------------------------------*/ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. import * as vscode from 'vscode'; diff --git a/src/util/process.ts b/src/util/process.ts index fb1f1ca..de4811d 100644 --- a/src/util/process.ts +++ b/src/util/process.ts @@ -1,7 +1,5 @@ -/*--------------------------------------------------------------------------------------------- - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See LICENSE.md in the project root for license information. - *--------------------------------------------------------------------------------------------*/ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. import * as cp from 'child_process'; import * as vscode from 'vscode'; diff --git a/src/util/timer.ts b/src/util/timer.ts index a8b8c19..ea373b4 100644 --- a/src/util/timer.ts +++ b/src/util/timer.ts @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + export default class Timer { static Timeout(delay: number): Promise { return new Promise(