-
Notifications
You must be signed in to change notification settings - Fork 74
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
Update README.md #417
Update README.md #417
Conversation
Updates readme to reflect new code review functionality
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.
PR Type: Documentation
PR Summary: The pull request updates the README.md to reflect the new code review functionality offered by Sourcery. It restructures the content to emphasize the updated features, such as the ability to review any pull request on GitHub, the introduction of a trial period for private repositories, and the clarification of privacy and security practices. The changes aim to provide a clearer understanding of Sourcery's offerings and to streamline the information presented to the users.
Decision: Comment
📝 Type: 'Documentation' - not supported yet.
- Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
✅ Small diff: the diff is small enough to approve with confidence.
No details provided.
General suggestions:
- Consider reintroducing a brief summary of what Sourcery is at the beginning of the README to help new users quickly grasp its purpose.
- Clarify acronyms like 'LLMs' for better understanding among users who may not be familiar with such terms.
- Add a call to action in the 'Feedback' section to encourage user engagement and feedback.
Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨
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.
Right now it's not selling it to me
I'd suggest the following structure
- Attention grabbing title
- One line super concise explanation of what it is "Instant AI code reviews on all your pull requests"
- Expound on the benefits
- Getting started
- What is Sourcery?
- More of an explanation here
- Screenshots
- ... rest
Co-authored-by: Brendan Maginnis <brendan@sourcery.ai>
Updates readme to reflect new code review functionality