Skip to content

Conversation

@Suhani370
Copy link

@Suhani370 Suhani370 commented Dec 23, 2025

  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
  • Bug fix
  • Feature implementation
  • Doc updates
  • Related Issue
  • What changes have you introduced?

  • Does this PR introduce a breaking change?

  • Preview / Steps to verify your work:

  • You can check the introduction.md file in the repository; under the Contributors section, it now shows my details:

Summary by Sourcery

Documentation:

  • Add a Contributors section to the introduction document listing Suhani Singh Vaishnavi and their GitHub profile.

@sourcery-ai
Copy link

sourcery-ai bot commented Dec 23, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds a new Contributor section to the introduction documentation, listing the PR author’s name and GitHub profile link.

File-Level Changes

Change Details Files
Add a Contributor section to the introduction documentation including contributor name and GitHub profile URL.
  • Append a new 'Contributor' subsection after the existing content in the introduction document.
  • List the contributor’s full name as a bullet point under the new section.
  • Provide the contributor’s GitHub profile URL alongside their name in the bullet point.
introduction.md

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

@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 - I've left some high level feedback:

  • Consider aligning with the existing project pattern for acknowledging contributors (e.g., a shared CONTRIBUTORS/AUTHORS section or file) rather than adding a single personal entry directly into introduction.md, to keep the introduction focused on the project itself.
  • You can simplify the formatting by avoiding extra blank lines before and after the new ## Contributor heading so the document’s spacing remains consistent with the rest of the file.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider aligning with the existing project pattern for acknowledging contributors (e.g., a shared CONTRIBUTORS/AUTHORS section or file) rather than adding a single personal entry directly into `introduction.md`, to keep the introduction focused on the project itself.
- You can simplify the formatting by avoiding extra blank lines before and after the new `## Contributor` heading so the document’s spacing remains consistent with the rest of the file.

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.

@Suhani370
Copy link
Author

Hello,
I have updated the introduction.md file to add a Contributors section. It now lists my details as follows:
Suhani Singh Vaishnavi
GitHub: https://github.com/Suhani370
Kindly have a look and let me know if any adjustments are needed. Thanks!

@Suhani370
Copy link
Author

Thanks for the review and the suggestion. I’ve reverted the contributor section from introduction.md to keep the introduction focused on the project and aligned with the existing documentation structure. Please let me know if contributors should instead be acknowledged in a separate file or section.

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