Update README and files #656
Conversation
|
🎉 Welcome @Kumarbapi03!
We appreciate your contribution! 🚀 |
WalkthroughReplaces CONTRIBUTING.md with a full onboarding guide, rewrites README.md structure and content, adds SETUP_CHECKLIST.md, and introduces a new Bright theme plus a themesList update; changes include documentation plus two new/modified theme source files. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20–30 minutes
Possibly related PRs
Suggested labels
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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 (9)
SETUP_CHECKLIST.md (1)
127-129: Wrap bare URLs in markdown link syntax.Lines 127–129 contain bare URLs that should be wrapped to improve accessibility and markdown compliance. Apply this diff:
-Discord: https://discord.gg/MMZBadkYFm -Email: [email protected] -Issues: https://github.com/AOSSIE-Org/Resonate/issues +Discord: [https://discord.gg/MMZBadkYFm](https://discord.gg/MMZBadkYFm) +Email: [[email protected]](mailto:[email protected]) +Issues: [https://github.com/AOSSIE-Org/Resonate/issues](https://github.com/AOSSIE-Org/Resonate/issues)CONTRIBUTING.md (4)
24-24: Wrap bare URLs in markdown link syntax throughout the document.Multiple bare URLs violate markdown best practices (MD034). Systematically wrap URLs in markdown link syntax. For example, at line 24:
- Download: https://git-scm.com/downloads + Download: [https://git-scm.com/downloads](https://git-scm.com/downloads)This applies to ~15+ instances throughout the file. Common patterns:
- Download/install links in prerequisites and setup sections
- Documentation links in troubleshooting and resources
- Community links (Discord, GitHub, etc.)
Also applies to: 28-28, 33-33, 34-34, 46-46, 57-57, 82-82, 198-198, 232-232, 344-344, 356-356, 650-653, 659-661
688-701: Add language specification to code block.Line 688 contains a project structure tree without a language specification. Add
textorplainto improve markdown compliance:-``` +```text Resonate/ ├── android/ # Android native code ... -``` +```
734-734: Convert emphasis to proper heading structure.Line 734 uses emphasis
**Happy Contributing! 🎉**but reads semantically as a closing heading. Consider converting to a proper heading or restructuring:-**Happy Contributing! 🎉** +## Happy Contributing! 🎉
736-736: Refine informal language for professional tone.Line 736 uses "amazing," which is informal. Consider a more professional alternative:
-Thank you for contributing to Resonate. Together, we're building an amazing open-source voice platform! +Thank you for contributing to Resonate. Together, we're building an excellent open-source voice platform!README.md (4)
128-128: Add language specification to fenced code blocks.Lines 128 and 359 contain fenced code blocks without language specifications (MD040). Add
textor the appropriate language:-``` +```text Resonate/ ├── android/ # Android native code ... -``` +```And for the license block at line 359:
-``` +```text Resonate - An Open Source Social Voice Platform Copyright (C) 2023-2025 AOSSIE ... -``` +```Also applies to: 359-359
291-291: Convert emphasis patterns to proper markdown headings where appropriate.Lines 291, 296, 301, 433, and 452 use emphasis (
**text**) for what appear to be subheadings (MD036). For example, line 291:-**Issue: "Cannot connect to Appwrite"** +### Issue: Cannot connect to AppwriteApply similarly to:
- Line 296:
**Issue: "LiveKit connection failed"**- Line 301:
**Issue: "Build failed"**- Line 433:
**Made with ❤️ by the AOSSIE Community**(consider as decorative or section marker)- Line 452:
**Happy Contributing! 🎉**(consider as closing statement)Also applies to: 296-296, 301-301, 433-433, 452-452
326-326: Wrap bare URLs in markdown link syntax.Lines 326 and 423–425 contain bare URLs that should be wrapped. For example, line 326:
-- 💬 **Discord**: [Join our server](https://discord.gg/MMZBadkYFm) +- 💬 **Discord**: [Join our server](https://discord.gg/MMZBadkYFm)And at lines 423–425:
-- **Email**: [email protected] -- **Discord**: https://discord.gg/MMZBadkYFm -- **GitHub**: https://github.com/AOSSIE-Org +- **Email**: [[email protected]](mailto:[email protected]) +- **Discord**: [https://discord.gg/MMZBadkYFm](https://discord.gg/MMZBadkYFm) +- **GitHub**: [https://github.com/AOSSIE-Org](https://github.com/AOSSIE-Org)Also applies to: 423-425
413-413: Refine informal language for professional tone.Line 413 uses "amazing," which is informal. Consider a more professional alternative:
-- **Appwrite** - For providing an amazing backend platform +- **Appwrite** - For providing a robust backend platform
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CONTRIBUTING.md(1 hunks)README.md(1 hunks)SETUP_CHECKLIST.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: M4dhav
Repo: AOSSIE-Org/Resonate PR: 510
File: .github/workflows/build_and_deploy.yml:31-36
Timestamp: 2025-08-31T16:18:53.594Z
Learning: For the AOSSIE-Org/Resonate project, build system requirements like Java version setup are considered separate from dependency update PRs and should be handled in dedicated PRs focused on build system improvements.
🪛 LanguageTool
CONTRIBUTING.md
[style] ~736-~736: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...g to Resonate. Together, we're building an amazing open-source voice platform!
(AWESOME)
README.md
[uncategorized] ~1-~1: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: # 🎤 Resonate - An Open Source Social Voice Platform <div align="cent...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~412-~412: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...nowledgments - AOSSIE - Australian Open Source Software Innovation and Education - **A...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~413-~413: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...ducation - Appwrite - For providing an amazing backend platform - LiveKit - For re...
(AWESOME)
[uncategorized] ~422-~422: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... - Organization: AOSSIE (Australian Open Source Software Innovation and Education) - **...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.18.1)
SETUP_CHECKLIST.md
127-127: Bare URL used
(MD034, no-bare-urls)
128-128: Bare URL used
(MD034, no-bare-urls)
129-129: Bare URL used
(MD034, no-bare-urls)
CONTRIBUTING.md
24-24: Bare URL used
(MD034, no-bare-urls)
28-28: Bare URL used
(MD034, no-bare-urls)
33-33: Bare URL used
(MD034, no-bare-urls)
34-34: Bare URL used
(MD034, no-bare-urls)
46-46: Bare URL used
(MD034, no-bare-urls)
57-57: Bare URL used
(MD034, no-bare-urls)
82-82: Bare URL used
(MD034, no-bare-urls)
198-198: Bare URL used
(MD034, no-bare-urls)
232-232: Bare URL used
(MD034, no-bare-urls)
344-344: Bare URL used
(MD034, no-bare-urls)
356-356: Bare URL used
(MD034, no-bare-urls)
650-650: Bare URL used
(MD034, no-bare-urls)
651-651: Bare URL used
(MD034, no-bare-urls)
652-652: Bare URL used
(MD034, no-bare-urls)
653-653: Bare URL used
(MD034, no-bare-urls)
659-659: Bare URL used
(MD034, no-bare-urls)
660-660: Bare URL used
(MD034, no-bare-urls)
661-661: Bare URL used
(MD034, no-bare-urls)
688-688: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
734-734: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
README.md
128-128: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
233-233: Images should have alternate text (alt text)
(MD045, no-alt-text)
233-233: Images should have alternate text (alt text)
(MD045, no-alt-text)
233-233: Images should have alternate text (alt text)
(MD045, no-alt-text)
237-237: Images should have alternate text (alt text)
(MD045, no-alt-text)
237-237: Images should have alternate text (alt text)
(MD045, no-alt-text)
237-237: Images should have alternate text (alt text)
(MD045, no-alt-text)
291-291: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
296-296: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
301-301: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
326-326: Bare URL used
(MD034, no-bare-urls)
351-351: Link fragments should be valid
(MD051, link-fragments)
359-359: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
423-423: Bare URL used
(MD034, no-bare-urls)
424-424: Bare URL used
(MD034, no-bare-urls)
425-425: Bare URL used
(MD034, no-bare-urls)
433-433: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
452-452: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (3)
SETUP_CHECKLIST.md (1)
86-86: Verify cross-reference to ONBOARDING.md.Line 86 references ONBOARDING.md, but this file is not included in the PR. Confirm whether:
- ONBOARDING.md exists in the repository, or
- This reference should point to CONTRIBUTING.md instead.
README.md (2)
351-351: Verify link fragment validity.Line 351 references an anchor
#contributing, but the section heading is## 🤝 Contributing(line 164). Markdown anchor generation may not handle emoji correctly. Test this link and adjust if necessary:-Want to see your name here? [Start contributing!](#contributing) +Want to see your name here? [Start contributing!](#-contributing)Alternatively, define an explicit anchor above the heading.
1-450: Approve overall documentation quality and structure.The README rewrite significantly improves documentation quality with:
- Clear, hierarchical organization (About, Features, Architecture, Quick Start, etc.)
- Comprehensive contributor guidance with step-by-step instructions
- Well-structured project architecture and tech stack sections
- Excellent use of badges, emojis, and visual hierarchy
- Strong community/support and contribution pathways
- Roadmap visibility
The few markdown linting issues identified above (alt text, bare URLs, emphasis patterns) are non-critical and easily remedied. The content is accurate, comprehensive, and welcoming to new contributors.
| | <img src="https://github.com/user-attachments/assets/f1d6e62f-5f25-47c1-9f59-e165d7018c0c" width="250" height="auto" /> | <img src="https://github.com/user-attachments/assets/b9dfe363-79b1-4eee-8d00-28f5c14f93ee" width="250" height="auto" /> | <img src="https://github.com/user-attachments/assets/c7657be8-bce2-4c3a-aee3-dd3cc33379a2" width="250" height="auto"/> | | ||
| | Login Screen | Home Screen | Create Room | | ||
| |:---:|:---:|:---:| | ||
| | <img src="docs/screenshots/login.png" width="200"/> | <img src="docs/screenshots/home.png" width="200"/> | <img src="docs/screenshots/create_room.png" width="200"/> | |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Add alt text to all screenshot images.
Lines 233 and 237 contain image tags without alt text, which violates accessibility standards (MD045). Add descriptive alt text:
-| <img src="docs/screenshots/login.png" width="200"/> | <img src="docs/screenshots/home.png" width="200"/> | <img src="docs/screenshots/create_room.png" width="200"/> |
+| <img src="docs/screenshots/login.png" width="200" alt="Login Screen"/> | <img src="docs/screenshots/home.png" width="200" alt="Home Screen"/> | <img src="docs/screenshots/create_room.png" width="200" alt="Create Room Screen"/> |Apply similarly to line 237:
-| <img src="docs/screenshots/room.png" width="200"/> | <img src="docs/screenshots/profile.png" width="200"/> | <img src="docs/screenshots/explore.png" width="200"/> |
+| <img src="docs/screenshots/room.png" width="200" alt="Room Screen"/> | <img src="docs/screenshots/profile.png" width="200" alt="Profile Screen"/> | <img src="docs/screenshots/explore.png" width="200" alt="Explore Stories Screen"/> |Also applies to: 237-237
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
233-233: Images should have alternate text (alt text)
(MD045, no-alt-text)
233-233: Images should have alternate text (alt text)
(MD045, no-alt-text)
233-233: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In README.md around lines 233 and 237, the inline image tags lack alt attributes
(violating MD045); update each <img> tag on those lines to include concise,
descriptive alt text (for example "Login screen", "Home screen", "Create room
screen") that accurately describes the screenshots so they meet accessibility
standards.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
lib/themes/theme_list.dart (1)
90-90: Add trailing newline at end of file.The file is missing a trailing newline, which is a common convention in most coding style guides and can be flagged by linters.
Apply this diff:
} +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (2)
lib/themes/bright_theme.dart(1 hunks)lib/themes/theme_list.dart(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: M4dhav
Repo: AOSSIE-Org/Resonate PR: 510
File: .github/workflows/build_and_deploy.yml:31-36
Timestamp: 2025-08-31T16:18:53.594Z
Learning: For the AOSSIE-Org/Resonate project, build system requirements like Java version setup are considered separate from dependency update PRs and should be handled in dedicated PRs focused on build system improvements.
🔇 Additional comments (2)
lib/themes/theme_list.dart (2)
82-82: Good improvement for case-insensitive theme matching.Making the theme lookup case-insensitive improves the API robustness and user experience by accepting theme names in any case format.
67-77: Removelib/themes/bright_theme.dart—it's unused and creates architectural confusion.The file defines a
brightThemeThemeData that is never imported or referenced anywhere in the codebase. The actual theme system uses ThemeModel entries (like the new "Bright" entry in theme_list.dart) which are converted to ThemeData bysetLightTheme()andsetDarkTheme()methods in theme.dart.The new Bright ThemeModel correctly defines the necessary colors (primary green, secondary blue, white surface, black text), so bright_theme.dart is redundant. If advanced theme properties from bright_theme.dart (like tertiary color, specific button styling, or text theme) are needed, integrate them into the setLightTheme method; otherwise, delete the file.
Likely an incorrect or invalid review comment.
| import 'package:flutter/material.dart'; | ||
|
|
||
| final ThemeData brightTheme = ThemeData( | ||
| brightness: Brightness.light, | ||
| primaryColor: Colors.white, | ||
| scaffoldBackgroundColor: Colors.white, | ||
| appBarTheme: const AppBarTheme( | ||
| backgroundColor: Colors.white, | ||
| foregroundColor: Colors.black, | ||
| elevation: 0, | ||
| iconTheme: IconThemeData(color: Colors.black), | ||
| ), | ||
| colorScheme: const ColorScheme.light( | ||
| primary: Color(0xFF4CAF50), // Vibrant green for action elements like Join Button | ||
| secondary: Color(0xFF2196F3), // Clean blue for share/connectivity icons | ||
| tertiary: Color(0xFFFF9800), // Soft orange for participant count (high contrast and clarity) | ||
| surface: Colors.white, | ||
| background: Colors.white, | ||
| onPrimary: Colors.white, | ||
| onSecondary: Colors.white, | ||
| onTertiary: Colors.white, | ||
| onBackground: Colors.black, | ||
| onSurface: Colors.black, | ||
| ), | ||
| elevatedButtonTheme: ElevatedButtonThemeData( | ||
| style: ElevatedButton.styleFrom( | ||
| backgroundColor: const Color(0xFF4CAF50), // Vibrant green Join Button | ||
| foregroundColor: Colors.white, | ||
| shape: RoundedRectangleBorder(borderRadius: BorderRadius.circular(30)), | ||
| ), | ||
| ), | ||
| iconTheme: const IconThemeData( | ||
| color: Color(0xFF2196F3), // Default blue for icons like Share | ||
| ), | ||
| textTheme: const TextTheme( | ||
| displayLarge: TextStyle(color: Colors.black, fontWeight: FontWeight.bold), | ||
| bodyLarge: TextStyle(color: Colors.black), | ||
| bodyMedium: TextStyle(color: Colors.black87), | ||
| labelLarge: TextStyle(color: Colors.white), // For button text | ||
| ), | ||
| // Ensures high contrast (WCAG AA compliant on white background) | ||
| // Can be extended for more elements if needed | ||
| ); No newline at end of file |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Search for brightTheme references in the codebase
rg -n "\bbrightTheme\b" --type=dartRepository: AOSSIE-Org/Resonate
Length of output: 134
🏁 Script executed:
# Search for imports of bright_theme.dart
rg -n "import.*bright_theme" --type=dartRepository: AOSSIE-Org/Resonate
Length of output: 45
🏁 Script executed:
# Check theme_list.dart for theme definitions
fd -n "theme_list.dart" --type=fRepository: AOSSIE-Org/Resonate
Length of output: 293
🌐 Web query:
WCAG AA contrast ratio requirements and contrast ratios for #4CAF50 #2196F3 #FF9800 on white background
💡 Result:
Summary — WCAG AA requirements
- Normal (body) text: contrast ≥ 4.5:1.
- Large text (≥18pt regular or ≥14pt bold): contrast ≥ 3:1. (w3.org)
Contrast of the given colors on white (#FFFFFF)
- #4CAF50 on white: 2.78:1 — fails AA for normal text, fails AA for large text (needs ≥3:1). (colorcombos.com)
- #2196F3 on white: 3.12:1 — fails AA for normal text (needs ≥4.5:1), passes AA for large text (≥3:1). (colorcombos.com)
- #FF9800 on white: 2.16:1 — fails AA for normal text and fails AA for large text. (colorcombos.com)
If you want, I can suggest accessible alternative shades (HEX) that meet AA (4.5:1) on white for each color.
Citations:
- 1: https://www.w3.org/WAI/WCAG21/Understanding/contrast-minimum?utm_source=openai
- 2: https://www.colorcombos.com/colors/4caf50?utm_source=openai
- 3: https://www.colorcombos.com/colors/2196F3?utm_source=openai
- 4: https://www.colorcombos.com/colors/ff9800?utm_source=openai
Address unused theme definition and incorrect WCAG compliance claim.
Two confirmed issues:
-
Unused code:
brightThemeis defined but never imported or referenced anywhere in the codebase. This file appears to be orphaned. Either integrate it into the application (e.g., intheme_list.dart) or remove it. -
Incorrect WCAG AA claim: The comment on lines 41-42 claims WCAG AA compliance, but the colors fail to meet WCAG AA standards:
#4CAF50(green): 2.78:1 contrast ratio — fails AA for normal text (requires 4.5:1) and large text (requires 3:1)#2196F3(blue): 3.12:1 contrast ratio — fails AA for normal text, barely passes for large text (≥18pt regular or ≥14pt bold)#FF9800(orange): 2.16:1 contrast ratio — fails AA for both normal and large text
Update the comment to reflect the actual contrast ratios or adjust the colors to meet WCAG AA requirements.
🤖 Prompt for AI Agents
In lib/themes/bright_theme.dart around lines 1 to 43, the brightTheme definition
is orphaned (never imported/used) and the inline comment claiming WCAG AA
compliance is incorrect; either import and register brightTheme where themes are
enumerated (e.g., add it to theme_list.dart and ensure it is selected/used) or
delete this file if the theme is not needed, and update the WCAG comment by
replacing the incorrect claim with real contrast numbers or by changing the
three failing colors to WCAG AA-compliant alternatives (choose colors that meet
≥4.5:1 for normal text or ≥3:1 for large text and update color constants and
text/onColor pairs accordingly).
1 participant
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes # (issue)
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Please include screenshots below if applicable.
Checklist:
Maintainer Checklist
Summary by CodeRabbit
Documentation
New Features
✏️ Tip: You can customize this high-level summary in your review settings.