Skip to content
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

chore: l10n_currencies v1.0.0 #288

Merged
merged 2 commits into from
Jan 24, 2025
Merged

chore: l10n_currencies v1.0.0 #288

merged 2 commits into from
Jan 24, 2025

Conversation

tsinis
Copy link
Owner

@tsinis tsinis commented Jan 24, 2025

Description

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • πŸ› οΈ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • πŸ§ͺ Tests
  • πŸ“ Documentation
  • βš™οΈ CI/CD or GitHub Workflow configuration change
  • πŸ“¦ Dependencies update

Checks

Please look at the following checklist to ensure that your PR can be accepted quickly:

  • Data come from open-source resources with MIT License (if presented).
  • New code is documented and the data source is referenced (if presented).
  • Existing tests are up to date with these changes.
  • New code is fully tested (if presented).

Summary by CodeRabbit

  • New Features

    • Added ability to inject custom translations to extend/modify existing ones
  • Documentation

    • Improved package documentation and examples
    • Fixed typos in README
  • Release

    • First stable release (version 1.0.0)
    • Updated package version number

Copy link

coderabbitai bot commented Jan 24, 2025

πŸ“ Walkthrough

Walkthrough

This pull request marks the first stable release of the l10n_currencies package, updating the version from 0.1.0 to 1.0.0. The changes include updating the version in the pubspec.yaml, adding a new changelog section in CHANGELOG.md, and making minor documentation improvements. A small formatting change was also made to an example file's comment, and the README was updated to highlight a feature for injecting custom translations.

Changes

File Change Summary
packages/l10n_currencies/CHANGELOG.md - Added version 1.0.0 section
- Added celebratory note "πŸŽ‰ First stable release!"
- Noted documentation improvements
- Fixed README typos
packages/l10n_currencies/README.md - Corrected typo "reccomended" to "recommended"
- Added documentation about custom translation injection
packages/l10n_currencies/example/lib/main.dart - Minor formatting change in comment (added space)
packages/l10n_currencies/pubspec.yaml - Updated version from 0.1.0 to 1.0.0

Possibly related PRs


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❀️ Share
πŸͺ§ Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

github-actions[bot]
github-actions bot previously approved these changes Jan 24, 2025
@github-actions github-actions bot added the dependencies Pull requests that update a dependency file label Jan 24, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

πŸ“œ Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 8d37e72 and 0a7c722.

πŸ“’ Files selected for processing (4)
  • packages/l10n_currencies/CHANGELOG.md (1 hunks)
  • packages/l10n_currencies/README.md (3 hunks)
  • packages/l10n_currencies/example/lib/main.dart (1 hunks)
  • packages/l10n_currencies/pubspec.yaml (1 hunks)
🧰 Additional context used
πŸͺ› Markdownlint (0.37.0)
packages/l10n_currencies/CHANGELOG.md

1-1: null
First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

πŸͺ› LanguageTool
packages/l10n_currencies/README.md

[duplication] ~17-~17: Possible typo: you repeated a word.
Context: ...upported out of the box. - Three-letter ISO ISO 4217 Alpha code lookup. - Fallback loca...

(ENGLISH_WORD_REPEAT_RULE)

πŸ”‡ Additional comments (3)
packages/l10n_currencies/pubspec.yaml (1)

1-1: LGTM! Version bump to 1.0.0 is appropriate.

The version bump to 1.0.0 is well justified as this marks the first stable release with improved documentation and examples.

packages/l10n_currencies/example/lib/main.dart (1)

10-10: LGTM! Improved comment formatting.

The added space before the code block improves readability.

packages/l10n_currencies/README.md (1)

19-19: LGTM! New feature documentation added.

The addition of custom translations feature documentation is valuable for users.

Copy link

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 100.00%. Comparing base (8d37e72) to head (24f9c63).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##              main      #288    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           30         2    -28     
  Lines          482       216   -266     
==========================================
- Hits           482       216   -266     
Flag Coverage Ξ”
l10n_currencies 100.00% <ΓΈ> (?)
sealed_languages ?

Flags with carried forward coverage won't be shown. Click here to find out more.

β˜” View full report in Codecov by Sentry.
πŸ“’ Have feedback on the report? Share it here.

@tsinis tsinis merged commit 3a039ed into main Jan 24, 2025
11 checks passed
@tsinis tsinis deleted the chore/l10n-currencies-v1 branch January 24, 2025 23:08
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

πŸ“œ Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 0a7c722 and 24f9c63.

πŸ“’ Files selected for processing (1)
  • packages/l10n_currencies/README.md (3 hunks)
πŸ”‡ Additional comments (4)
packages/l10n_currencies/README.md (4)

12-12: LGTM!

Clear recommendation for package usage in Dart-only context.


17-17: LGTM - Redundancy fixed!

The redundant "ISO" has been removed, improving documentation clarity.


47-47: LGTM!

Clear and well-formatted comment in the example.


76-76: LGTM!

Excellent addition of package size information with clear explanation of its benefits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant