-
Notifications
You must be signed in to change notification settings - Fork 10
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.
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
feat: updating marketplace info and walkthrough #250
feat: updating marketplace info and walkthrough #250
Conversation
Reviewer's Guide by SourceryThis pull request updates the marketplace information and walkthrough for Sourcery, focusing on code reviews and the coding assistant. The changes include updating the README, modifying the welcome file, adding a new file for GitHub code reviews, and removing some outdated files. File-Level Changes
Tips
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @angrycaptain19 - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider retaining or updating the privacy/security section instead of removing it entirely, as this is important information for users.
- It might be helpful to briefly explain why certain features (like CLI and duplicate code detection) have been removed or de-emphasized, if that's the case.
Here's what I looked at during the review
- 🟢 Functionality: all looks good
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 3 issues found
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice - looked like some useful review comments from sourcery there
@Hellebore note - it'd be good to update the walkthrough to add a completion event for a review command being run as well
Summary by Sourcery
Update the documentation to reflect Sourcery's new role as a code reviewer and coding assistant, with a focus on providing code reviews directly in the IDE and integration with GitHub and GitLab. Enhance the walkthrough to guide users on utilizing these new features.
New Features:
Enhancements:
Documentation: