Skip to content

Improve README documentation#3113

Closed
aarthiga-jayakumar wants to merge 1 commit intofossasia:devfrom
aarthiga-jayakumar:dev
Closed

Improve README documentation#3113
aarthiga-jayakumar wants to merge 1 commit intofossasia:devfrom
aarthiga-jayakumar:dev

Conversation

@aarthiga-jayakumar
Copy link
Copy Markdown

@aarthiga-jayakumar aarthiga-jayakumar commented Mar 31, 2026

This PR improves the README by adding a contribution section to guide new contributors.

Summary by Sourcery

Documentation:

  • Expand README with a contribution section to guide new contributors on how to get involved.

Added a contribution section with guidelines for contributors.
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Mar 31, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates README documentation to better support new contributors by adding and refining contribution-related guidance.

File-Level Changes

Change Details Files
Enhance contributor guidance in the README.
  • Add a dedicated contribution section outlining how new contributors can get started
  • Document basic workflow or expectations for submitting changes (e.g., forking, branching, and opening pull requests)
  • Clarify any project-specific contribution conventions or links to further documentation
README.rst

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
Copy Markdown
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 - 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.

Copy link
Copy Markdown
Member

@ArnavBallinCode ArnavBallinCode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution, closing this pr as this change is not in scope at the moment.
Please refer to open issues for future contributions!

@github-project-automation github-project-automation bot moved this from Backlog to Done in Eventyay Next Mar 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants