File tree Expand file tree Collapse file tree 1 file changed +27
-0
lines changed
Expand file tree Collapse file tree 1 file changed +27
-0
lines changed Original file line number Diff line number Diff line change @@ -145,6 +145,33 @@ Run `pnpm` in root directory to add pre-commit hooks:
145145pnpm install --ignore-scripts
146146```
147147
148+ ## 💡 Quick Tip for Onboarding
149+
150+ Use Q CLI to help you onboard Q CLI!
151+
152+ Start a ` q chat ` session:
153+
154+ ``` shell
155+ q chat
156+ ```
157+
158+ Once inside ` q chat ` , you can supply project context by adding the [ ` codebase-summary.md ` ] ( codebase-summary.md ) file:
159+
160+ ``` shell
161+ /context add codebase-summary.md
162+ ```
163+
164+ This enables Q to answer onboarding questions like:
165+
166+ - “What does this crate do?”
167+
168+ - “Where is X implemented?”
169+
170+ - “How do these components interact?”
171+
172+ Great for speeding up your ramp-up and navigating the repo more effectively.
173+
174+
148175## Security
149176
150177See [ CONTRIBUTING] ( CONTRIBUTING.md#security-issue-notifications ) for more information.
You can’t perform that action at this time.
0 commit comments