Skip to content

Update capabilities documentation with recommended best practices #1066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 27, 2025
Merged

Update capabilities documentation with recommended best practices #1066

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion docs/gen/capabilities.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,39 @@ Codegen's brain (powered by Claude 3.7 Sonnet) intelligently selects and combine
3. Execute the necessary actions across GitHub, Linear, and your codebase
4. Provide clear, helpful responses back in Slack

This seamless integration allows you to manage your entire development workflow through simple conversations, without having to switch between different platforms and interfaces.
This seamless integration allows you to manage your entire development workflow through simple conversations, without having to switch between different platforms and interfaces.

## Recommended Best Practices for Using Codegen

Here are some recommended best practices for integrating Codegen effectively into your development workflow:

### Workflow Integration

- **Small bug fixes**: For minor issues, consider using Codegen for instant fixes and merges
- **Larger tickets**: A multi-step approach often works best:
1. Ask Codegen to do a first pass on the implementation
2. Check out the branch and review the changes
3. Add any necessary adjustments
4. QA the changes
5. Merge the code

### When to Use Codegen vs. IDE

Consider using Codegen for:
- Initial exploration and first pass on tickets and engineering efforts
- Quickly gathering context on issues (e.g., explaining errors in notification threads)
- Understanding the "blast radius" of a given change to assess its impact
- Getting a solid first pass at approximately 80% of your work

Use your preferred IDE (like Cursor or VS Code) for:
- Making precise adjustments after Codegen's first pass
- Detailed work that requires deep context

### Effectiveness Tips

- Be diligent about analyzing tasks and determining how to break them down for Codegen
- Split complex tasks into manageable chunks
- Don't hesitate to discard unhelpful outputs and try a different approach
- View Codegen as a powerful assistant rather than an infallible oracle

These practices can help you leverage Codegen effectively while maintaining high code quality and productivity.
Loading