added changelog file #603
added changelog file #603
Conversation
|
🎉 Welcome @Charan-BS!
We appreciate your contribution! 🚀 |
WalkthroughAdded a multi-language CHANGELOG.md documenting releases 1.0.0–3.0.0 and updated localization resources: Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
🔇 Additional comments (1)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
CHANGELOG.md (1)
106-108: Standardize language listing order across v3.0.0 sections.The "New Language Support" subsections list languages in inconsistent orders:
- en-US (lines 106–108): Gujarati, Marathi, Kannada
- mr-IN (lines 146–148): मराठी, गुजराती, कन्नड (Marathi, Gujarati, Kannada)
- kn-IN (lines 159–161): ಕನ್ನಡ, ಗುಜರಾತಿ, ಮರಾಠಿ (Kannada, Gujarati, Marathi)
Choose one consistent order (e.g., alphabetical by language name, or by addition date) and apply it across all language subsections for clarity and maintainability.
Also applies to: 146-148, 159-161
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CHANGELOG.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md
[grammar] ~15-~15: Ensure spelling is correct
Context: ...onate का प्रथम संस्करण - आवाज़ कहानियाँ बनाएं और सुनें - सीधा ऑडियो कमरों में शामिल ह...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~15-~15: Ensure spelling is correct
Context: ... संस्करण - आवाज़ कहानियाँ बनाएं और सुनें - सीधा ऑडियो कमरों में शामिल हों - अपने आयोजन ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~42-~42: Ensure spelling is correct
Context: ...್ಯಗಳು - Resonate ನ ಮೊದಲ ಬಿಡುಗಡೆ - ಧ್ವನಿ ಕಥೆಗಳು ರಚಿಸಿ ಮತ್ತು ಕೇಳಿ - ನೇರ ಧ್ವನಿ ಕೋಣೆಗಳಿಗೆ ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~44-~44: Ensure spelling is correct
Context: ... ಕೋಣೆಗಳಿಗೆ ಸೇರಿ - ನಿಮ್ಮ ಕಾರ್ಯಕ್ರಮಗಳನ್ನು ನಿಗದಿಪಡಿ - ಪೇರ್ ಚಾಟ್ ಮೂಲಕ ಹೊಸಜನರನ್ನು ಪರಿಚಯಿಸಿಕೊಳ್ಳಿ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~45-~45: Ensure spelling is correct
Context: ...ರ್ಯಕ್ರಮಗಳನ್ನು ನಿಗದಿಪಡಿ - ಪೇರ್ ಚಾಟ್ ಮೂಲಕ ಹೊಸಜನರನ್ನು ಪರಿಚಯಿಸಿಕೊಳ್ಳಿ - ಮುಕ್ತ ಮೂಲದ ಸಾಮಾಜಿಕ ಧ್ವ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~84-~84: Ensure spelling is correct
Context: ...र जोडून थेट कॉल करा - कथा आणि वापरकर्ते यांची जलद शोध ### kn-IN #### ಹೊಸ ವೈಶಿಷ್ಟ್ಯಗಳ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~159-~159: Ensure spelling is correct
Context: ...ೊಸ ಆಯ್ಕೆಗಳು #### ಹೊಸ ಭಾಷಾ ಬೆಂಬಲ - ಕನ್ನಡ - ಗುಜરಾತಿ - ಮರಾಠಿ
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Run Software Tests
🔇 Additional comments (1)
CHANGELOG.md (1)
1-161: Verify version ordering convention.The changelog lists versions in ascending order (1.0.0, 2.0.0, 3.0.0). Most changelogs follow descending order (newest first) for quick access to recent changes. Verify this is intentional or if you'd prefer to reverse the order for better UX. Either way, ensure consistency with your project's conventions.
CHANGELOG.md
Outdated
| ### New Language Support | ||
| - Gujarati | ||
| - Marathi | ||
| - Kannada | ||
|
|
||
|
|
||
| ### hi-IN | ||
| ### नई सुविधाओं | ||
| - लाइव चैप्टर्स: स्टोरी चैप्टर्स लाइव शुरू करें | ||
| - रूम सर्च: आप जिन कमरों को खोज रहे हैं, उन्हें तेज़ी से ढूँढें | ||
| - होस्ट मॉडरेशन और यूजर रिपोर्टिंग: होस्ट के लिए बेहतर मॉडरेशन और एक उपयोगकर्ता रिपोर्टिंग प्रणाली। | ||
| - रूम हटाएँ: उपयोगकर्ता अब कमरों को हटा सकते हैं। | ||
| - अतिरिक्त ऐप सेटिंग्स: आपके अनुभव पर अधिक नियंत्रण के लिए हमने सेटिंग्स मेनू में और विकल्प जोड़े हैं। | ||
|
|
||
| ### नई भाषा का समर्थन | ||
| - गुजराती | ||
| - मराठी | ||
| - कन्नड़ | ||
|
|
There was a problem hiding this comment.
Fix v3.0.0 structure and heading levels for consistency with v1.0.0 and v2.0.0.
Two structural issues in v3.0.0:
-
Lines 105–109: The "New Language Support" subsection breaks the established pattern. In v1.0.0 and v2.0.0, each language subsection contains only that language's features. This generic section interrupts the language-specific organization and duplicates information found in each language's subsection. Move language support details into each language subsection (e.g., as a separate subheading under the language).
-
Lines 111–123 (hi-IN): The section uses
### नई सुविधाओंand### नई भाषा का समर्थन, but should use####(four hashes) to maintain consistency with other language subsections (see lines 3–4 for en-US, lines 12–13 for hi-IN in v1.0.0, etc.).
Apply this structure for each language section:
### [Language-Code]
#### [Feature Category Header]
- [features]
🤖 Prompt for AI Agents
In CHANGELOG.md around lines 105 to 123, move the three language bullets under
"New Language Support" into each language’s own subsection and change the hi-IN
subheadings from ### नई सुविधाओं and ### नई भाषा का समर्थन to use #### (four
hashes) so they match the established pattern; restructure so each language
block follows the pattern "### [Language-Code]" then one or more "#### [Feature
Category]" headers with their bullets (i.e., remove the separate generic "New
Language Support" section and place those language entries as a #### subheading
within each language section).
M4dhav
added
documentation
|
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
left a comment
M4dhav
left a comment
There was a problem hiding this comment.
Please change formatting for the changelogs. You can use Angular Brackets to wrap notes, like so:
|
I will do it now |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
CHANGELOG.md (1)
48-93: Minor stylistic observation: language support handling differs between v2.0.0 and v3.0.0.In v2.0.0, Hindi language support is listed as a feature item under "New Features" (line 53: "Hindi language support"). In v3.0.0, new language support is separated into its own
#### New Language Supportsection. This inconsistency is likely intentional—reflecting that v3.0.0 adds multiple languages simultaneously, warranting a distinct section—but be aware that tooling or CI pipelines expecting consistent section structures might need adjustment.If consistency is critical for CI workflows parsing release notes, consider either (a) retroactively adding a dedicated "New Language Support" section to v2.0.0 with Hindi, or (b) consolidating v3.0.0's language support back into "New Features" as individual items. This is optional and depends on your release note automation requirements.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CHANGELOG.md(1 hunks)android/untranslated.txt(0 hunks)untranslated.txt(0 hunks)
💤 Files with no reviewable changes (2)
- android/untranslated.txt
- untranslated.txt
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md
[grammar] ~15-~15: Ensure spelling is correct
Context: ...onate का प्रथम संस्करण - आवाज़ कहानियाँ बनाएं और सुनें - सीधा ऑडियो कमरों में शामिल ह...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~42-~42: Ensure spelling is correct
Context: ...್ಯಗಳು - Resonate ನ ಮೊದಲ ಬಿಡುಗಡೆ - ಧ್ವನಿ ಕಥೆಗಳು ರಚಿಸಿ ಮತ್ತು ಕೇಳಿ - ನೇರ ಧ್ವನಿ ಕೋಣೆಗಳಿಗೆ ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~44-~44: Ensure spelling is correct
Context: ... ಕೋಣೆಗಳಿಗೆ ಸೇರಿ - ನಿಮ್ಮ ಕಾರ್ಯಕ್ರಮಗಳನ್ನು ನಿಗದಿಪಡಿ - ಪೇರ್ ಚಾಟ್ ಮೂಲಕ ಹೊಸಜನರನ್ನು ಪರಿಚಯಿಸಿಕೊಳ್ಳಿ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~45-~45: Ensure spelling is correct
Context: ...ರ್ಯಕ್ರಮಗಳನ್ನು ನಿಗದಿಪಡಿ - ಪೇರ್ ಚಾಟ್ ಮೂಲಕ ಹೊಸಜನರನ್ನು ಪರಿಚಯಿಸಿಕೊಳ್ಳಿ - ಮುಕ್ತ ಮೂಲದ ಸಾಮಾಜಿಕ ಧ್ವ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~84-~84: Ensure spelling is correct
Context: ...र जोडून थेट कॉल करा - कथा आणि वापरकर्ते यांची जलद शोध ### kn-IN #### ಹೊಸ ವೈಶಿಷ್ಟ್ಯಗಳ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~159-~159: Ensure spelling is correct
Context: ...ೊಸ ಆಯ್ಕೆಗಳು #### ಹೊಸ ಭಾಷಾ ಬೆಂಬಲ - ಕನ್ನಡ - ಗುಜરಾತಿ - ಮರಾಠಿ
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (1)
CHANGELOG.md (1)
97-161: Structural improvements applied; heading levels now consistent across all versions.The v3.0.0 section now properly maintains the established heading hierarchy—each language subsection uses
####(four hashes) for feature categories, consistent with v1.0.0 and v2.0.0. Language support is now localized within each language section (e.g., "नई भाषा का समर्थन" under hi-IN, "નવી ભાષા આધાર" under gu-IN) rather than as a single generic section, which improves clarity and parallelism.
|
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? |
2 participants
Description
Added a complete
CHANGELOG.mdfile for the Resonate app.This includes:
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?
Checklist:
Maintainer Checklist
Summary by CodeRabbit
Documentation
New Features
Localization