Skip to content

Update CONTRIBUTING.md localization section#3406

Merged
arkid15r merged 3 commits into
vacanza:devfrom
arkid15r:ark/update-contributing-md
Mar 30, 2026
Merged

Update CONTRIBUTING.md localization section#3406
arkid15r merged 3 commits into
vacanza:devfrom
arkid15r:ark/update-contributing-md

Conversation

@arkid15r

Copy link
Copy Markdown
Collaborator

Proposed change

Update CONTRIBUTING.md localization section wording.

Type of change

  • New country/market holidays support (thank you!)
  • Supported country/market holidays update (calendar discrepancy fix, localization)
  • Existing code/documentation/test/process quality improvement (best practice, cleanup, refactoring, optimization)
  • Dependency update (version deprecation/pin/upgrade)
  • Bugfix (non-breaking change which fixes an issue)
  • Breaking change (a code change causing existing functionality to break)
  • New feature (new holidays functionality in general)

Checklist

@coderabbitai

coderabbitai Bot commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 59d24e9a-434b-4b7e-a940-74d9838f9551

📥 Commits

Reviewing files that changed from the base of the PR and between 5d8bacc and ff2a3fd.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Summary by CodeRabbit

  • Documentation
    • Clarified localization contribution workflow: copy translation templates into the default-language folder and leave holiday-name entries empty there; translate only non-default locales after copying. Added a note that empty entries in default-language files are intentional (holiday names are authored in source) and should not be treated as missing translations or duplicated unless explicitly requested.

Walkthrough

Updated CONTRIBUTING.md localization instructions to require copying generated .po templates into the entity's default-language folder with holiday-name msgstr left empty, and to translate only non-default locales after copying; adds a note that empty msgstr in default-language .po is intentional.

Changes

Cohort / File(s) Summary
Localization documentation
CONTRIBUTING.md
Clarified .po handling: copy template into default-language folder, keep holiday-name msgstr empty for default locales, and translate only non-default locales after copying; added explicit note against treating empty msgstr as missing translations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested labels

l10n

Suggested reviewers

  • PPsyrius
  • KJhellico
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and clearly describes the main change: updating the localization section of CONTRIBUTING.md with improved wording and instructions.
Description check ✅ Passed The description is related to the changeset, noting it's a documentation quality improvement for the localization section, though it lacks specific detail about what was changed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov

codecov Bot commented Mar 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (144bd80) to head (ff2a3fd).
⚠️ Report is 7 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff            @@
##               dev     #3406   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          310       310           
  Lines        18586     18586           
  Branches      2381      2381           
=========================================
  Hits         18586     18586           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@arkid15r arkid15r marked this pull request as ready for review March 25, 2026 01:27
@arkid15r arkid15r enabled auto-merge March 25, 2026 01:27
Comment thread CONTRIBUTING.md Outdated
@arkid15r arkid15r marked this pull request as draft March 26, 2026 05:38
auto-merge was automatically disabled March 26, 2026 05:38

Pull request was converted to draft

@PPsyrius

Copy link
Copy Markdown
Collaborator

@arkid15r I'm thinking of reviving and finishing #3204 so that we can further simplify the process here for new contributors

@arkid15r arkid15r marked this pull request as ready for review March 28, 2026 16:11
@arkid15r arkid15r enabled auto-merge March 28, 2026 16:11
@sonarqubecloud

Copy link
Copy Markdown

@arkid15r arkid15r requested a review from PPsyrius March 28, 2026 16:11

@PPsyrius PPsyrius left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM 🗒️

Let's update this again in another PR once #3204 is merged in

@arkid15r arkid15r added this pull request to the merge queue Mar 30, 2026
Merged via the queue into vacanza:dev with commit 0ff811f Mar 30, 2026
32 checks passed
@arkid15r arkid15r deleted the ark/update-contributing-md branch March 30, 2026 17:52
@KJhellico KJhellico mentioned this pull request Apr 6, 2026
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.

2 participants