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

Commit 16d75e6

Browse files
author
Eyal
authored
Merge branch 'master' into scheyal-patch-6
2 parents 345f824 + 4c626d7 commit 16d75e6

File tree

1 file changed

+99
-0
lines changed

1 file changed

+99
-0
lines changed

Internal-Hackathon-Oct-18-2019.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# Internal Hackathon for SDK 4.6 release
2+
3+
Where: Kitchen
4+
When: October 18, 2019 10:00am to noon
5+
Who: You :)
6+
7+
**Goal**: Get team’s assistance in flushing out last minute items to support smooth transition from legacy tools to new and improved BF CLI.
8+
9+
10+
Please file issues here: https://github.com/microsoft/botframework-cli/issues
11+
12+
## Instructions
13+
* Download and install from: **TBD:Emilio**
14+
* Ensure Telemetry is enabled: **TBD:Emilio**
15+
* Hack it: Use to create/manage bots
16+
* Hack it challenge: Use with Virtual Assistant
17+
18+
For any questions and feedback please talk to us!
19+
20+
_Eyal, Emilio, Axel, and Jonathan_
21+
22+
## Example Hack Objectives
23+
24+
### Global / Foundation
25+
Owner: **Emilio + Eyal**
26+
* Ensure documentation quality in MS DOCS and READMEs (links: a, b, c)
27+
* Ensure command line consistency across all tools
28+
* Ensure foundation & all command groups align to Contributing.md guideline (common flags, I/O ops, logging)
29+
* Ensure npm Installation paths, messaging (link)
30+
* Ensure deprecation messages on corresponding legacy tools
31+
* Ensure telemetry accuracy
32+
* Ensure configuration management
33+
* Enable/Disable telemetry & verify accuracy in telemetry logging
34+
* Security/Privacy pass complete (not hackathon per se)
35+
36+
### Chatdown
37+
Owner: **Jonathan**
38+
* Ensure commands and flags work as expected, testing instructions below
39+
40+
### qnamaker
41+
Owner: **Emilio**
42+
43+
### Ludown
44+
Owner: **Emilio**
45+
46+
### LuisGen
47+
Owner: **Axel**
48+
49+
* Generate file with no specific name (use class name)
50+
* Generate file with specific name different than class name
51+
* Generate file with no specific name and target name already exists
52+
* Generate file with specific name and target name already exists
53+
* Generate file with no specific name, target name already exists and send force flag
54+
* Generate file with specific name, target name already exists and send force flag
55+
56+
## Example Scenarios
57+
58+
* Convert chatdown script from Emulator (?)
59+
* QnAMaker: Prepare, create, train, publish, delete KB
60+
* Luis: convert .lu / .luis files
61+
* Challenge: Create & run a Virtual Assistant script (that's what the VA team will do after Ignite if you didn't do it for them :))
62+
63+
## Other Suggestions
64+
65+
### Chatdown
66+
67+
Run the following commands and ensure the results match the expectations, indicated in square brackets:
68+
69+
bf chatdown
70+
bf chatdown -h
71+
[should display the help contents]
72+
73+
(echo bot=jon) | ./bin/run chatdown
74+
[should display transcript in console]
75+
76+
bf chatdown --in ./test/utils/cli.sample.chat
77+
bf chatdown --in 'C:\Projects\cli\botframework-cli\packages\chatdown\test\utils\cli.sample.chat' [absolute path to file]
78+
[should output transcipt file to console]
79+
80+
bf chatdown --in ./test/utils/cli.sample.chat --prefix
81+
[should output transcipt file to console, prefixed with the package name]
82+
83+
bf chatdown --in ./test/utils/cli.doesntexist.chat
84+
[should display an error message: 'no such file or directory']
85+
86+
bf chatdown --in ./test/utils/cli.sample.chat --out ./test/testout
87+
[should output transcipt file to specified dir]
88+
89+
bf chatdown --in ./test/utils/cli.sample.chat --out 'C:\Projects\cli\botframework-cli\packages\chatdown\test\utils\testout' [absolute path to directory]
90+
[should output transcipt file to specified dir]
91+
92+
bf chatdown --in ./test/utils/cli.sample.chat --out ./test/doesntexist
93+
[should create a dir that doesnt exist and output transcipt file there ]
94+
95+
---
96+
<img src="https://github.com/microsoft/botframework-cli/blob/esbfclispec2/BF%20CLI%20Hackathon%20Flyer.jpg"
97+
alt="Bot Framework CLI Hackathon"
98+
style="float: left; margin-right: 10px;" />
99+

0 commit comments

Comments
 (0)