Skip to content
This repository was archived by the owner on Jan 15, 2025. It is now read-only.

Added requirement for design/review #97

Closed
scheyal wants to merge 2 commits into from
Closed

Added requirement for design/review #97

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d4ed89
Added requirement for design/review
Aug 19, 2019
6444b32
More guidance around preview mode
Aug 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion specs/ContributionGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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'
Expand All @@ -10,4 +14,9 @@
1. To add a command, inside the plugin folder run 'npx oclif command <command-name>'. If you want to add a subcommand just name it colon separated as <command-name:subcommand-name>
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<any> = {}
4. Implement the run method
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.