Skip to content

Conversation

@vedansh-5
Copy link
Member

@vedansh-5 vedansh-5 commented Aug 15, 2025

📌 Fixes

Fixes #232


📝 Summary of Changes

  • Adds a contributing guide for newcomers.

✅ 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

Add a dedicated contributing guide and update the README to reference it

Documentation:

  • Create CONTRIBUTING.md with instructions for reporting bugs, requesting features, setting up the development environment, submitting pull requests, and adding translations
  • Link to the new contributing guide in the README
  • Remove outdated contribution and localization instructions from the README

Signed-off-by: Vedansh Saini <[email protected]>
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Aug 15, 2025

Reviewer's Guide

This PR extracts and expands the project's contribution instructions into a dedicated CONTRIBUTING.md file, refactors the README.md to link to it and cleans up obsolete sections including language localization and PR guidelines, and adds a license section.

File-Level Changes

Change Details Files
Introduce dedicated CONTRIBUTING.md with comprehensive contribution workflow
  • Created CONTRIBUTING.md as a new root file
  • Outlined steps for bug reports, feature requests, and pull request setup
  • Documented development environment setup and token configuration
  • Specified code formatting, linting, and semantic versioning guidelines
  • Included section on adding new languages and translation contributions
CONTRIBUTING.md
Refactor README.md to reference the new guide and remove outdated content
  • Added a concise "Contributing" section linking to CONTRIBUTING.md
  • Inserted a license section with LGPL-2.1 details
  • Removed old language localization instructions and in-README contribution details
  • Cleaned up extra blank lines and streamlined build instructions
README.md

Assessment against linked issues

Issue Objective Addressed Explanation
#232 Add a contribution guide to the repository to help newcomers understand how to contribute.
#232 Update project documentation to reference and link to the new contribution guide.

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 there - I've reviewed your changes - here's some feedback:

  • Consider adding the new Contributing section to the README’s table of contents so it’s easy for users to discover.
  • In CONTRIBUTING.md, clarify whether contributors should load the src folder or the built extension folder when testing locally, to avoid confusion.
  • The GitHub personal access token setup may be optional for many contributors—consider marking it as an advanced step to keep the initial setup lean.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider adding the new Contributing section to the README’s table of contents so it’s easy for users to discover.
- In CONTRIBUTING.md, clarify whether contributors should load the `src` folder or the built extension folder when testing locally, to avoid confusion.
- The GitHub personal access token setup may be optional for many contributors—consider marking it as an advanced step to keep the initial setup lean.

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.

@vedansh-5 vedansh-5 self-assigned this Aug 15, 2025
@vedansh-5 vedansh-5 requested a review from hpdang August 15, 2025 06:29
@vedansh-5
Copy link
Member Author

The failing check is not related to this specific PR, its a thing of release drafter workflow. This has to be handled separately, currently the drafter workflow produces release notes.

@hpdang hpdang merged commit 4d5b94a into fossasia:master Aug 20, 2025
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Enhancement]: Contribution guide

2 participants