Skip to content

Commit 6cbee1e

Browse files
Fix formatting issues in prompting.mdx
- Fix numbered list formatting (use 1. for all items) - Remove trailing whitespace - Add proper blank lines before headers - Ensure file ends with newline
1 parent 7366c62 commit 6cbee1e

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

docs/introduction/prompting.mdx

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ If there are specific implementation details you want included, make sure to spe
2525
## Elements of a Strong Prompt
2626

2727
1. **Scope:** What repository, branch, or files are involved? (e.g., `my-web-app` repo, `PR #42`, `src/services/user.ts`)
28-
2. **Goal:** What is the high-level objective? (e.g., Refactor `UserService`, improve testability)
29-
3. **Tasks:** What specific actions should the agent take? Use a numbered or bulleted list for clarity. (e.g., Extract logic to `UserRepository`, use dependency injection, update tests, update diagram)
30-
4. **Context/Patterns:** Are there existing patterns, examples, or documentation to reference? (e.g., `ProductService`, `ProductRepository`)
31-
5. **Success Criteria:** How will you know the task is done correctly? (e.g., Tests pass, 90%+ coverage, diagram updated)
28+
1. **Goal:** What is the high-level objective? (e.g., Refactor `UserService`, improve testability)
29+
1. **Tasks:** What specific actions should the agent take? Use a numbered or bulleted list for clarity. (e.g., Extract logic to `UserRepository`, use dependency injection, update tests, update diagram)
30+
1. **Context/Patterns:** Are there existing patterns, examples, or documentation to reference? (e.g., `ProductService`, `ProductRepository`)
31+
1. **Success Criteria:** How will you know the task is done correctly? (e.g., Tests pass, 90%+ coverage, diagram updated)
3232

3333
## Platform-Specific Guidance
3434

@@ -43,9 +43,9 @@ Example Slack prompt:
4343
```
4444
@codegen In the `api-server` repo, can you:
4545
1. Add input validation to the `/users` endpoint
46-
2. Use the same validation pattern as `/products`
47-
3. Add tests covering edge cases
48-
4. Update the OpenAPI spec
46+
1. Use the same validation pattern as `/products`
47+
1. Add tests covering edge cases
48+
1. Update the OpenAPI spec
4949
5050
Let me know when you have a PR ready! 🚀
5151
```
@@ -82,8 +82,8 @@ Example GitHub prompt:
8282
```
8383
@codegen Please review this PR focusing on:
8484
1. Security implications of the new auth flow
85-
2. Performance impact of the database queries
86-
3. Test coverage for edge cases
85+
1. Performance impact of the database queries
86+
1. Test coverage for edge cases
8787
8888
Also check if the error handling follows our patterns in `utils/errors.ts`.
8989
```
@@ -162,10 +162,10 @@ For interconnected changes:
162162
```
163163
I need to update the user model across multiple services:
164164
1. Add `preferences` field to User model in `user-service`
165-
2. Update the GraphQL schema in `api-gateway`
166-
3. Modify the frontend components in `web-app/src/components/user/`
167-
4. Add database migration scripts
168-
5. Update all related tests
165+
1. Update the GraphQL schema in `api-gateway`
166+
1. Modify the frontend components in `web-app/src/components/user/`
167+
1. Add database migration scripts
168+
1. Update all related tests
169169
170170
Please coordinate these changes and create PRs in the correct order.
171171
```
@@ -218,3 +218,4 @@ If you're unsure how to structure a prompt for your specific use case:
218218
- Ask Codegen to suggest how to break down complex tasks
219219
- Reference the [capabilities documentation](/introduction/capabilities) to understand available tools
220220
- Check out real examples in our [use cases section](/use-cases)
221+

0 commit comments

Comments
 (0)