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

Commit 1c08bee

Browse files
authored
Merge pull request #251 from microsoft/esbfclimain
removed hackathon flyer
2 parents 5746c9e + 52e4d18 commit 1c08bee

File tree

3 files changed

+12
-129
lines changed

3 files changed

+12
-129
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
2. Inside the project folder run 'npm run build'
77
3. Inside the packages folder(https://github.com/microsoft/botframework-cli/tree/master/packages) run 'npx oclif plugin <plugin-name>'
88
4. Follow the wizard and set the prompts:
9-
9+
1010
? npm package: @microsoft/bf-<plugin-name>
1111
? description: <Plugin brief description>
1212
? author: Microsoft
@@ -19,32 +19,32 @@
1919
? Use tslint (linter for TypeScript): Y
2020
? Use mocha (testing framework): Y
2121
? Add CI service config (Press <space> to select, <a> to toggle all, <i> to invert selection): select any
22-
22+
2323
4. Go to the folder created by the previous command and add @microsoft/bf-cli-command as a dependency in your package.json file
24-
24+
2525
"dependencies": {
2626
...,
2727
"@microsoft/bf-cli-command": "1.0.0",
2828
...
2929
}
30-
30+
3131
5. At the root level(https://github.com/microsoft/botframework-cli) run 'npm run build' to bootstrap the packages
3232

3333
## Steps to create a new command
3434
1. Inside the plugin folder run 'npx oclif command <command-name>'.
3535
a. To add a subcommand use a colon separated format as follows:
3636
<command-name:subcommand-name>
3737
2. Replace the import 'import {Command, flags} from '@oclif/command' line inside the newly created command with '@microsoft/bf-cli-command'
38-
38+
3939
- import {Command, flags} from '@oclif/command'
4040
+ import {Command, flags} from '@microsoft/bf-cli-command'
41-
41+
4242
3. Add the typing to the flags property like this if needed:
43-
43+
4444
static flags: flags.Input<any> = {
4545
help: flags.help({description: 'Display help'}),
4646
}
47-
47+
4848
4. Implement the run method
4949

5050
## General Guidelines
@@ -89,7 +89,7 @@ Use the following verbs for standard commands
8989
* Commands and options are case SenSiTive, specified in lower case. *bf cmd:subcmd*.
9090
* Multi word options are lowcase, nohyphen, multiwords. Multi word commands are forbidden.
9191
* Prefer flags to args
92-
* Commands shall follow the *bf \[noun\]\[verb\]\[noun\]* form for example *bf qnamaker:create:kb*.
92+
* Commands shall follow the *bf \[noun\]\[noun\]\[verb\]* form for example *bf qnamaker:create:kb*.
9393
* FLags with specific units:
9494
* In general, DO NOT put units in Flag names. ALWAYS put the expected units in the help text. Example: --durationinminutes should simply be --duration. This prevents the need to add more arguments later if more units are supported.
9595
* Consider allowing a syntax that will let the user specify units. For example, even if the service requires a value in minutes, consider accepting 1h or 60m. It is fine to assume a default (i.e. 60 = 60 minutes).

Internal-Hackathon-Oct-18-2019.md

Lines changed: 0 additions & 119 deletions
This file was deleted.

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ npm i -g @microsoft/botframework-cli
4040
To view detailed usage information see the [CLI ReadMe page](https://github.com/microsoft/botframework-cli/tree/master/packages/cli)
4141

4242
## Issues and Feature Requests
43-
Please file issues and feature requests [here](https://github.com/microsoft/botframework-cli/issues).
43+
Please file issues and feature requests [here](https://github.com/microsoft/botframework-cli/issues).
44+
45+
Also, see current [known issues](https://github.com/microsoft/botframework-cli/labels/known-issues).
4446

4547
Thank you for your support.
4648

0 commit comments

Comments
 (0)