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

feat: updating marketplace info and walkthrough #250

Merged
merged 5 commits into from
Sep 17, 2024

Conversation

angrycaptain19
Copy link
Contributor

@angrycaptain19 angrycaptain19 commented Sep 16, 2024

@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:

  • Introduce the ability for Sourcery to provide code reviews directly within the IDE, allowing users to get feedback on their code anytime.

Enhancements:

  • Update the README and documentation to reflect the new capabilities of Sourcery, emphasizing its role as a code reviewer and coding assistant.
  • Improve the walkthrough documentation to guide users on how to use Sourcery for code reviews in GitHub and GitLab repositories.

Documentation:

  • Revise the README to highlight Sourcery's new features, including on-demand code reviews and integration with GitHub and GitLab.
  • Add new documentation files to guide users on setting up Sourcery for GitHub and GitLab code reviews.
  • Remove outdated documentation sections related to Sourcery CLI and pre-commit hooks.

Copy link
Contributor

sourcery-ai bot commented Sep 16, 2024

Reviewer's Guide by Sourcery

This 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

Change Details Files
Updated README to focus on code reviews and coding assistant features
  • Revised the introduction to emphasize code reviews and coding assistance
  • Added sections for code reviews on demand and GitHub & GitLab PR reviews
  • Removed sections on multi-file analysis, duplicate code detection, and Sourcery CLI
  • Updated the order of features to prioritize code review functionality
README.md
Modified welcome-to-sourcery.py to highlight code review functionality
  • Rearranged the content to focus on code review features
  • Added information about getting reviews on PRs in GitHub and GitLab
  • Moved the example function to after the explanation of code review features
welcome-to-sourcery.py
Updated walkthrough files to reflect new focus on code reviews
  • Rewrote code_reviews.md to focus on in-IDE code reviews
  • Updated view_welcome_file.md to introduce code review functionality
  • Added github_code_reviews.md for GitHub and GitLab specific information
  • Removed custom_rules_tutorial.md and refactoring_scan.md
walkthrough/code_reviews.md
walkthrough/view_welcome_file.md
walkthrough/github_code_reviews.md

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@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.

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 ✨

LangSmith trace

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

welcome-to-sourcery.py Outdated Show resolved Hide resolved
welcome-to-sourcery.py Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
walkthrough/view_welcome_file.md Show resolved Hide resolved
angrycaptain19 and others added 2 commits September 16, 2024 16:27
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Copy link
Contributor

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

Pipfile Outdated Show resolved Hide resolved
@angrycaptain19 angrycaptain19 merged commit cdc447f into main Sep 17, 2024
1 check passed
@angrycaptain19 angrycaptain19 deleted the tim/feat/marketplace-listing-updates-2024 branch September 17, 2024 13:24
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.

2 participants