Skip to content

Readme updated #214

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

Preeti9764
Copy link
Contributor

@Preeti9764 Preeti9764 commented Jul 26, 2025

📝 Summary of Changes

  • Updated readme for added gitlab support

✅ Checklist

  • I’ve tested my changes locally
  • I’ve added tests (if applicable)
  • I’ve updated documentation (if applicable)
  • My code follows the project’s code style guidelines

👀 Reviewer Notes

Add any special notes for the reviewer here

Summary by Sourcery

Revise README to introduce GitLab support alongside GitHub, update feature list, installation, and usage sections for multi-platform support.

Enhancements:

  • Expand the features list with multi-platform activity tracking, flexible date ranges, and smart caching TTL.

Documentation:

  • Extend the overview to cover both GitHub and GitLab integration.
  • Add a "Supported Platforms" section outlining GitHub and GitLab-specific capabilities.
  • Update installation steps and usage instructions to include platform selection and updated settings UI.

Copy link
Contributor

sourcery-ai bot commented Jul 26, 2025

Reviewer's Guide

This PR enhances README.md to support GitLab alongside GitHub, enriches feature descriptions, adds platform-specific sections and usage instructions for platform selection, clarifies GitHub-only features, and tidies formatting.

File-Level Changes

Change Details Files
Add GitLab support and enrich feature descriptions
  • Updated introduction to reference both GitHub and GitLab
  • Expanded feature list with multi-platform support, comprehensive tracking, flexible date ranges, and smart caching
  • Adjusted feature bullet formatting for consistency
README.md
Introduce Supported Platforms section
  • Added new section with separate GitHub and GitLab subsections
  • Detailed API support, repository filtering, rate limits, and contribution tracking per platform
README.md
Update installation and usage instructions for platform selection
  • Modified install steps to include platform selection field
  • Added a 'Platform Selection' usage subsection explaining dropdown behavior and settings persistence
README.md
Clarify GitHub-only features
  • Tagged Advanced Repository Filtering and Include Commits on Existing PRs as GitHub-only
  • Retained notes on token requirements
README.md
Cleanup formatting and whitespace
  • Removed extraneous blank lines
  • Standardized list indentation and spacing
  • Minor copy edits for consistency
README.md

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

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 @Preeti9764 - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Preeti9764 Preeti9764 requested a review from hpdang July 30, 2025 07:15
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.

1 participant