Merge pull request #161 from microsoft/emilio/luis

Adding Contributing.md

Author: munozemilio

specs/ContributionGuide.md CONTRIBUTING.mdspecs/ContributionGuide.md renamed to CONTRIBUTING.md

@@ -5,15 +5,46 @@
     1. Clone the repo by running 'git clone https://github.com/microsoft/botframework-cli.git'
     2. Inside the project folder run 'npm run build'
     3. Inside the packages folder(https://github.com/microsoft/botframework-cli/tree/master/packages) run 'npx oclif plugin <plugin-name>'
+    4. Follow the wizard and set the prompts:
+
+      ? npm package: @microsoft/bf-<plugin-name>
+      ? description: <Plugin brief description>
+      ? author: Microsoft
+      ? version: 1.0.0
+      ? license: MIT
+      ? Who is the GitHub owner of repository (https://github.com/OWNER/repo): microsoft
+      ? What is the GitHub name of repository (https://github.com/owner/REPO): botframework-cli
+      ? Select a package manager: npm
+      ? TypeScript: Y
+      ? Use tslint (linter for TypeScript): Y
+      ? Use mocha (testing framework): Y
+      ? Add CI service config (Press <space> to select, <a> to toggle all, <i> to invert selection): select any
+
     4. Go to the folder created by the previous command and add @microsoft/bf-cli-command as a dependency in your package.json file
+
+      "dependencies": {
+        ...,
+        "@microsoft/bf-cli-command": "1.0.0",
+        ...
+      }   
+
     5. At the root level(https://github.com/microsoft/botframework-cli) run 'npm run build' to bootstrap the packages
 
 ## Steps to create a new command
     1. Inside the plugin folder run 'npx oclif command <command-name>'. 
     	a. To add a subcommand use a colon separated format as follows: 
     		<command-name:subcommand-name>
-    2. Replace the import 'import {Command, options} from '@oclif/command' line inside the newly created command with 'import {Command, options} from '@microsoft/bf-cli-command'
-    3. Add the type to the options property like this: static options: options.Input<any> = {}
+    2. Replace the import 'import {Command, flags} from '@oclif/command' line inside the newly created command with '@microsoft/bf-cli-command'
+
+      - import {Command, flags} from '@oclif/command'
+      + import {Command, flags} from '@microsoft/bf-cli-command'
+
+    3. Add the typing to the flags property like this if needed:
+
+      static flags: flags.Input<any> = {
+        help: flags.help({description: 'Display help'}),
+      }
+
     4. Implement the run method
 
 ## General Guidelines
@@ -55,14 +86,14 @@ Use the following verbs for standard commands
 
 ### Other
 
-* Commands and options are case InSenSiTive, specified in lower case. So *bf Cmd:SubCmd* is same as  *bf cmd:subcmd*.
+* Commands and options are case SenSiTive, specified in lower case. *bf cmd:subcmd*.
 * Multi word options are lowcase, nohyphen, multiwords. Multi word commands are forbidden.
-* Always have attribute-value pairs on command line args (i.e. bf cmd --arg \<val\>, NOT bf cmd \<val\>).
+* Prefer flags to args
 * Commands shall follow the *bf \[noun\]\[verb\]\[noun\]* form for example *bf qnamaker:create:kb*. 
-* Arguments with specific units: 
-  * In general, DO NOT put units in argument 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. 
+* FLags with specific units: 
+  * 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. 
   * 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).
-  * It is acceptable to use a unit in the argument name when it is used like an enum. For example, --startday is okay when it accepts MON, TUE, etc. --starthour is okay when it indicates an hour of the day.
+  * It is acceptable to use a unit in the flag name when it is used like an enum. For example, --startday is okay when it accepts MON, TUE, etc. --starthour is okay when it indicates an hour of the day.
 * Avoid having multiple arguments that simply represent different ways of getting the same thing. Instead, use a single descriptive name and overload it appropriately. For example, assume a command which can accept a parameter file through a URL or local path.
 
 ### Porting Rules