Skip to content

Commit 7256935

Browse files
authored
Merge pull request #1 from githubnext/conversation
document conversation
2 parents 22d56ce + 6836aed commit 7256935

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

HeyGitHub/README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,8 @@ For example, we can say things like, "Hey, GitHub, toggle sidebar."
4141

4242
## Modes
4343

44-
We understand that using the hot word over and over again can get old pretty soon, especially when developers are in the zone for building software. So we made a special "code mode" just to avoid tongue fatigue.
45-
46-
In code mode, developers do not have to say, "Hey, GitHub!" to activate the speech-to-text service. The extension continuously listens and assumes that the developer intends to synthesize code.
47-
48-
We certainly have not forgotten about editing code and controlling the IDE functionality within the “code mode.” After the code has been generated and is still in the `ghost text` formatting, simply start the utterance with "edit code by ..."; this will signal the extension developer's intent to edit the code.
49-
50-
Likewise, begin an utterance with "Hey Github, ..."; that will signal the extension to interpret the command as IDE control rather than the code generation.
51-
52-
For instance, saying "move to line five" in `code-mode` will cause the extension to to get a code completion. In contrast, saying "Hey GitHub, move to line five" will result in the cursor moving to line 5 (provided it exists).
53-
54-
44+
We understand that using the hot word over and over again can get old pretty soon, especially when developers are in the zone for building software. So we made a special "active mode" just to avoid tongue fatigue.
45+
In active mode, developers do not have to say, "Hey, GitHub!" to activate the speech-to-text service. The extension continuously listens and responds appropriately to the commands. To activate the active mode, developers can say, "Hey, GitHub, start active mode." To deactivate the active mode, developers can say, "stop active mode."
5546

5647
## Command Categories
5748
The voice commands can be broadly categorized into two categories:
@@ -104,7 +95,7 @@ These commands help with writing code:
10495
<a href="#top">Back to top</a>
10596
# Tips and Tricks
10697

107-
While we would like to chase the dream of having a very natural and conversational experience with the `Hey, GitHub!` extension, we are still in the early stages of development. Therefore, we would like to highlight some tips and tricks to help you get the most out of the extension.
98+
We are chasing the dream of having a very natural and conversational experience with the `Hey, GitHub!` extension, but are still in the early stages of development. Therefore, we would like to highlight some tips and tricks to help you get the most out of the extension.
10899

109100
- If the larger functionality is not generating the desired results, consider breaking down the problem into smaller pieces. For example, if we want to generate a rock-paper-scissors game, we can start by generating a series of functions that can be used to play the game. Then, we can use the generated functions to build the game.
110101
- a function to randomly select between rock, paper, and scissors
@@ -116,6 +107,13 @@ While we would like to chase the dream of having a very natural and conversation
116107
- "lets put it all together" - oftentimes, this phrase is useful to write a function that can tie together the smaller functions we have generated earlier.
117108
- If the goal is to synthesize a method body, consider using the following formulation: "a method `intended method name` that accepts parameters `parameter names with types` that `intended functionality` and optionally return `return type`"
118109

110+
- You can ask the extension to explain code to you, for example "explain lines 5 to 9"
111+
112+
- You can also converse with the assistant. For example here is your side of one possible conversation:
113+
- give me some ideas to add up a list of numbers
114+
- ok, show me some code
115+
- ok, let's insert that code
116+
119117
- Since the extension relies on the GitHub Copilot infrastructure, it is important to note that the code completions responses are non-deterministic. Therefore, it is possible that the extension may return slightly different code completions for the same input. Thus, canceling the code completions and trying again may yield a different result.
120118

121119
- The underlying speech recognition technology estimates the end of an utterance based on the silence in the audio stream. Since different folks have different speaking styles, we have left the silence threshold as a configurable parameter. You can change the silence threshold by editing the `Hey, GitHub!` extension settings. The default value is 1.25 seconds. However, if you are feeling particularly adventurous, try setting the value to 0.5 seconds.

0 commit comments

Comments
 (0)