Skip to content

Conversation

Aqil-Ahmad
Copy link

@Aqil-Ahmad Aqil-Ahmad commented Oct 4, 2025

Fixes #1493

Changes

Updated README.md. Added a dedicated Translations section with Weblate link for contributors

Checklist:

  • No hard coding: I have used resources from constants.dart without hard coding any value.
  • No end of file edits: No modifications done at end of resource files.
  • Code reformatting: I have reformatted code and fixed indentation in every file included in this pull request.
  • Code analyzation: My code passes analyzations run in flutter analyze and tests run in flutter test.

Summary by Sourcery

Documentation:

  • Add Translations section to README linking to the project's Weblate translation platform

Copy link
Contributor

sourcery-ai bot commented Oct 4, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR enriches the project documentation by introducing a dedicated Translations section in the README, providing contributors with a direct link to the Weblate platform for managing language translations.

File-Level Changes

Change Details Files
Added a new Translations section in the README
  • Introduced '## Translations' heading
  • Added guidance for translators to support the project
  • Included the Weblate project URL
README.md

Assessment against linked issues

Issue Objective Addressed Explanation
#1493 Add information to the README for translators about how to support the project in Weblate, including the relevant link.

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 a link to the new Translations section in the README’s table of contents so it’s discoverable without scrolling.
  • For consistency, wrap the Weblate URL in markdown link syntax (e.g., [Weblate project page](https://hosted.weblate.org/projects/fossasia/badge-magic-app/)).
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider adding a link to the new Translations section in the README’s table of contents so it’s discoverable without scrolling.
- For consistency, wrap the Weblate URL in markdown link syntax (e.g., `[Weblate project page](https://hosted.weblate.org/projects/fossasia/badge-magic-app/)`).

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.

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.

Add info for translators to Readme
1 participant