Skip to content

Commit 0c20190

Browse files
authored
Merge pull request #6 from github/feature/add-research-command
docs: add /research slash command to course content
2 parents 90cb0d8 + f92ee6b commit 0c20190

3 files changed

Lines changed: 24 additions & 5 deletions

File tree

01-setup-and-first-steps/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -360,6 +360,7 @@ These commands work in interactive mode. **Start with just these four** - they c
360360
| `/help` | Show all available commands | When you forget a command |
361361
| `/clear` | Clear conversation and start fresh | When switching topics |
362362
| `/plan` | Plan your work out before coding | For more complex features |
363+
| `/research` | Deep research using GitHub and web sources | When you need to investigate a topic before coding |
363364
| `/model` | Show or switch AI model | When you want to change the AI model |
364365
| `/exit` | End the session | When you're done |
365366

@@ -398,6 +399,7 @@ That's it for getting started! As you become comfortable, you can explore additi
398399
|---------|--------------|
399400
| `/diff` | Review the changes made in the current directory |
400401
| `/review` | Run the code-review agent to analyze changes |
402+
| `/research` | Run deep research investigation using GitHub and web sources |
401403
| `/terminal-setup` | Enable multiline input support (shift+enter and ctrl+enter) |
402404

403405
### Permissions

03-development-workflows/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ This chapter covers five workflows that developers typically use. **However, you
4949
| Track down and fix a bug | [Workflow 3: Debugging](#workflow-3-debugging) |
5050
| Generate tests for my code | [Workflow 4: Test Generation](#workflow-4-test-generation) |
5151
| Write better commits and PRs | [Workflow 5: Git Integration](#workflow-5-git-integration) |
52+
| Research before coding | [Quick Tip: Research Before You Plan or Code](#quick-tip-research-before-you-plan-or-code) |
5253
| See a full bug-fix workflow end to end | [Putting It All Together](#putting-it-all-together-bug-fix-workflow) |
5354

5455
**Select a workflow below to expand it** and see how GitHub Copilot CLI can enhance your development process in that area.
@@ -685,6 +686,22 @@ copilot
685686
686687
---
687688
689+
## Quick Tip: Research Before You Plan or Code
690+
691+
When you need to investigate a library, understand best practices, or explore an unfamiliar topic, use `/research` to run a deep research investigation before writing any code:
692+
693+
```bash
694+
copilot
695+
696+
> /research What are the best Python libraries for validating user input in CLI apps?
697+
```
698+
699+
Copilot searches GitHub repositories and web sources, then returns a summary with references. This is useful when you're about to start a new feature and want to make informed decisions first. You can share the results using `/share`.
700+
701+
> 💡 **Tip**: `/research` works well *before* `/plan`. Research the approach, then plan the implementation.
702+
703+
---
704+
688705
## Putting It All Together: Bug Fix Workflow
689706
690707
Here's a complete workflow for fixing a reported bug:

07-putting-it-together/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -139,20 +139,20 @@ copilot
139139

140140
# Learn: "find_by_author doesn't work with partial names"
141141

142-
# PHASE 2: Find related code
142+
# PHASE 2: Research best practice (deep research with web + GitHub sources)
143+
> /research Best practices for Python case-insensitive string matching
144+
145+
# PHASE 3: Find related code
143146
> @samples/book-app-project/books.py Show me the find_by_author method
144147

145-
# PHASE 3: Get expert analysis
148+
# PHASE 4: Get expert analysis
146149
> /agent
147150
# Select "python-reviewer"
148151

149152
> Analyze this method for issues with partial name matching
150153

151154
# Agent identifies: Method uses exact equality instead of substring matching
152155

153-
# PHASE 4: Research best practice
154-
> What are the best practices for Python case-insensitive string matching?
155-
156156
# PHASE 5: Fix with agent guidance
157157
> Implement the fix using lowercase comparison and 'in' operator
158158

0 commit comments

Comments
 (0)