Resonate icon indicating copy to clipboard operation
Resonate copied to clipboard

added changelog file

Open Charan-BS opened this issue 1 month ago • 9 comments

Description

Added a complete CHANGELOG.md file for the Resonate app.
This includes:

  • Versioned changelogs for v1.0.0, v2.0.0, and v3.0.0
  • Fully localized release notes in:
    • en-US
    • hi-IN
    • gu-IN
    • mr-IN
    • kn-IN
  • Clean markdown formatting with consistent sections:
    • New Features
    • Language Support (where applicable)

This provides a single place for maintainers and contributors to track feature changes, language additions, and version updates.

Fixes #585

Type of change

New feature (documentation addition — non-breaking)

How Has This Been Tested?

  • Verified formatting with GitHub markdown preview
  • Checked consistency across all versions (1.0.0 → 3.0.0)
  • Ensured all translations are clean, correct, and follow app’s localization style
  • Confirmed all sections follow project’s documentation standards

Checklist:

  • [x] My code follows the style guidelines of this project
  • [x] I have performed a self-review of my own work
  • [x] I have commented my code / documentation where needed
  • [x] I have made corresponding changes to the documentation
  • [x] My changes generate no new warnings
  • [x] I have added tests (N/A — documentation change only)
  • [x] New and existing unit tests pass locally (N/A — documentation change only)
  • [x] Any dependent changes have been merged and published in downstream modules
  • [x] I have checked my changes for typos and formatting issues

Maintainer Checklist

  • [x] closes #585

Summary by CodeRabbit

  • Documentation

    • Added extensive multilingual changelog entries for v1.0.0–v3.0.0, with localized headings and summaries.
  • New Features

    • Announced core features: Voice Stories, Live Audio Rooms, Events, Pair Chat, Rooms chat, Live Chapters, search, moderation, follow/call features, and app settings.
  • Localization

    • Added Gujarati, Marathi, and Kannada notes; updated Hindi and English entries.
    • Removed obsolete/untranslated mapping content across some locale files.

Charan-BS avatar Nov 14 '25 21:11 Charan-BS

🎉 Welcome @Charan-BS!
Thank you for your pull request! Our team will review it soon. 🔍

  • Please ensure your PR follows the contribution guidelines. ✅
  • All automated tests should pass before merging. 🔄
  • If this PR fixes an issue, link it in the description. 🔗

We appreciate your contribution! 🚀

github-actions[bot] avatar Nov 14 '25 21:11 github-actions[bot]

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Added a multilingual CHANGELOG.md with entries for versions 1.0.0–3.0.0 in several Indian locales. Removed content from android/untranslated.txt (file emptied) and deleted the entire untranslated.txt translation mappings. No code or public API declarations changed.

Changes

Cohort / File(s) Change Summary
Changelog Documentation
CHANGELOG.md
Added extensive multilingual changelog entries for versions 1.0.0, 2.0.0, and 3.0.0 across en-IN, hi-IN, gu-IN, mr-IN, and kn-IN.
Android untranslated resource (emptied)
android/untranslated.txt
Removed the single JSON content ({}), resulting in an empty file.
Project untranslated resource (removed)
untranslated.txt
Deleted the entire JSON mapping that previously contained gu, kn, and mr translation key arrays; file now contains no content.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verify CHANGELOG.md locale headings, separators, and encoding.
  • Confirm removal/emptied files are intentional and not referenced by build or tooling.
  • Check repository or CI steps that consume untranslated.txt/android/untranslated.txt to avoid runtime/missing-resource issues.

🐇 I nibbled lines and swapped some keys,

Wrote changelogs in joyful squeaks,
Emptied files and left a trail,
A tidy hop — a tiny tale,
Carrots, changelogs, cozy tweaks.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning The PR includes out-of-scope deletions: it removes all content from untranslated.txt and android/untranslated.txt files without clear connection to the changelog objective. Clarify why untranslated.txt and android/untranslated.txt were deleted. If unrelated to the changelog feature, revert those deletions to keep the PR focused on its stated objective.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'added changelog file' is directly related to the main change, which is the addition of a new CHANGELOG.md file with multilingual release notes.
Linked Issues check ✅ Passed The PR successfully addresses issue #585 by creating a CHANGELOG.md with versioned entries (1.0.0-3.0.0) in multiple languages, enabling change tracking for maintainers and contributors.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

coderabbitai[bot] avatar Nov 14 '25 21:11 coderabbitai[bot]

Hey @Charan-BS , like CodeRabbit suggested, the formatting needs to be such that Workflows can easily detect what are release notes and what aren't

M4dhav avatar Nov 15 '25 13:11 M4dhav

I will do it now

Charan-BS avatar Nov 15 '25 17:11 Charan-BS

I made the changes just how the coderabbit suggested, hope that works

but i have deleted untranslated.txt files, should i add it real quick and push the changes?

Charan-BS avatar Nov 15 '25 17:11 Charan-BS

Sorry for that, Can you brief how the formatting should be?

i just followed what is suggested by code rabbit, and i can see code rabbit review is complete.

Charan-BS avatar Nov 18 '25 07:11 Charan-BS

I recommend formatting it like so: <en-IN> ✨ What’s New:

💬 Chat in Rooms (with notifications) 🌐 Hindi language support 🤝 Improved Pair Chat: choose or rate users ⭐ Follow creators and get updates 👫 Add and call friends directly 🔍 Faster search for stories and users Update now for a better Resonate experience! 🎉 </en-IN>

<hn-IN> ✨ नया क्या है:

💬 रूम्स में चैट और नोटिफिकेशन 🌐 हिंदी भाषा सपोर्ट 🤝 बेहतर पेयर चैट: यूज़र चुनें या रेट करें ⭐ क्रिएटर्स को फॉलो करें और अपडेट पाएं 👫 दोस्तों को जोड़ें और कॉल करें 🔍 कहानियों और यूज़र्स के लिए तेज़ सर्च बेहतर अनुभव के लिए अभी अपडेट करें! 🎉 </hn-IN>

and so on

The reason we need it to be structured is that both the release and build workflows will directly use this to get release notes

M4dhav avatar Nov 18 '25 07:11 M4dhav

Looks good. Please fix conflicts and I will merge

M4dhav avatar Nov 18 '25 09:11 M4dhav

Looks like changes to the files were recorded as part of the commits. Your git history might be causing these issues. A quick fix would be copying the changelog, resetting to upstream/dev, and then commiting with the changelog again. Then you will need to force push the branch

M4dhav avatar Nov 18 '25 09:11 M4dhav

Great work, thank you for the contribution.

M4dhav avatar Nov 19 '25 10:11 M4dhav

PR Closed - Thank You, @Charan-BS!

  • If this PR was merged: Congratulations! Your contribution is now part of the project. 🚀
  • If this PR was closed without merging: Don’t worry! You can always improve it and submit again. 💪

We appreciate your effort and look forward to more contributions from you! 🤝

github-actions[bot] avatar Nov 19 '25 10:11 github-actions[bot]