use rules in auto-edit #6930
Draft
use rules in auto-edit #6930
+1,704
−173
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
sqs
added a commit
that referenced
this pull request
Feb 5, 2025
For our code review agent (announced in EAP in https://sourcegraph.com/blog/introducing-enterprise-ai-agents), we're introducing rules that are `*.rule.md` files placed in `.sourcegraph/` dirs in your codebase. The code review agent uses these rules to find and fix issues at code review. This PR makes it so that Cody in the editor also reads the rules and uses them in chat and inline edit for higher quality and consistency. It is behind the `"cody.rules.enabled": true` VS Code user setting, which is marked as `experimental`. Docs and blog post coming soon after we've merged this and tested it in our own dev workflows. - Closes https://linear.app/sourcegraph/issue/CODY-4829. - Depends on sourcegraph/sourcegraph#3305. - Depends on #6932. - Depends on #6931. - See related #6930, which makes rules work in auto-edit. https://github.com/user-attachments/assets/4d193edc-bdaf-4081-bbf3-c657f91a2bbe   ## Known issues - [ ] The `text_content_filters` and `repo_filters` rule fields are not yet implemented. - [ ] Editor (not sidebar) chat does not show the rules for the file in the other pane because it's not active - [ ] There are Node.js FS errors printed to the debug console when looking for `.sourcegraph` dirs. These are perhaps not being properly suppressed. ## Test plan 1. Set `"cody.rules.enabled": true` in your VS Code settings. 1. Clone the https://github.com/sourcegraph/review-agent-sandbox repository. 1. Open it in VS Code. 1. Open `handler_review.go`. 1. Open Cody chat. Ensure that it shows `N rules` in the chat. Run a chat and ensure it uses the rules. (It should say so in the response.) 1. Run an inline edit. Ensure that the `Rules` are listed in the inline edit initially right when you press <kbd>Opt+K</kbd> and then that the rules apply. 1. Try modifying a rule or creating a new one in `.sourcegraph/*.rule.md`. Ensure that it starts showing up in chat. There are no e2e tests yet; this is just being enabled for experimental dogfooding internally.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TODO
Rules work well in chat and inline edit but not in auto-edit. I separated out the PR to apply rules in auto-edit so that we can work on improving this later. See @hitesh-1997's comment at https://sourcegraph.slack.com/archives/C085U078XE0/p1738413947012609?thread_ts=1738405616.264529&cid=C085U078XE0 for more pointers.