From 4d4ed89def19851470e20d11709fff0ef3216af8 Mon Sep 17 00:00:00 2001 From: Eyal Date: Mon, 19 Aug 2019 13:01:28 -0700 Subject: [PATCH 1/2] Added requirement for design/review --- specs/ContributionGuide.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/specs/ContributionGuide.md b/specs/ContributionGuide.md index 8c977e1ad..4bec65833 100644 --- a/specs/ContributionGuide.md +++ b/specs/ContributionGuide.md @@ -1,5 +1,9 @@ # Contribution guide +## Pre-requisites + 1. Review and follow guidelines based on [Foundation Dev Spec](https://github.com/microsoft/botframework-cli/blob/master/specs/FoundationDevSpec.md) + 2. Create a corresponding design spec & schedule a review with BF CLI primary owners + ## Steps to create a new plugin 1. Clone the repo by running 'git clone https://github.com/microsoft/botframework-cli.git' 2. Inside the project folder run 'npm run build' @@ -10,4 +14,4 @@ 1. To add a command, inside the plugin folder run 'npx oclif command '. If you want to add a subcommand just name it colon separated as 2. Replace the import 'import {Command, flags} from '@oclif/command' line inside the newly created command with 'import {Command, flags} from '@microsoft/bf-cli-command' 3. Add the type to the flags property like this: static flags: flags.Input = {} - 4. Implement the run method \ No newline at end of file + 4. Implement the run method From 6444b3260c06b383150742849d2c0328de351d0c Mon Sep 17 00:00:00 2001 From: Eyal Date: Mon, 19 Aug 2019 13:26:34 -0700 Subject: [PATCH 2/2] More guidance around preview mode --- specs/ContributionGuide.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/specs/ContributionGuide.md b/specs/ContributionGuide.md index 4bec65833..36d3464d9 100644 --- a/specs/ContributionGuide.md +++ b/specs/ContributionGuide.md @@ -15,3 +15,8 @@ 2. Replace the import 'import {Command, flags} from '@oclif/command' line inside the newly created command with 'import {Command, flags} from '@microsoft/bf-cli-command' 3. Add the type to the flags property like this: static flags: flags.Input = {} 4. Implement the run method + +## Stage Preview + 1. All command groups in preview shall display the following message in help and run: Preview: This command is in preview stage. Please use with discretion and report any issues in the git repository. + 2. File an issue for review and scheduling into GA + 3. If command group is in early stages of development, direct users to your forked repository.