Skip to content
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

Merged
merged 4 commits into from
Jan 30, 2024
Merged

Update README.md #417

merged 4 commits into from
Jan 30, 2024

Conversation

angrycaptain19
Copy link
Contributor

Updates readme to reflect new code review functionality

Updates readme to reflect new code review functionality
Copy link

@sourcery-ai sourcery-ai bot left a 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? ✨

Share Sourcery

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link
Collaborator

@brendanator brendanator left a 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

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Brendan Maginnis <brendan@sourcery.ai>
@angrycaptain19 angrycaptain19 merged commit 4e559ad into main Jan 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants