Skip to content

Commit 6836aed

Browse files
committed
add some brief notes about the new conversational experience
1 parent fa0b98e commit 6836aed

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

HeyGitHub/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ These commands help with writing code:
9595
<a href="#top">Back to top</a>
9696
# Tips and Tricks
9797

98-
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.
9999

100100
- 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.
101101
- a function to randomly select between rock, paper, and scissors
@@ -107,6 +107,13 @@ While we would like to chase the dream of having a very natural and conversation
107107
- "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.
108108
- 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`"
109109

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+
110117
- 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.
111118

112119
- 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)