docs: improve onboarding for first-time contributors #679
Conversation
|
🎉 Welcome @Smitaambiger!
We appreciate your contribution! 🚀 |
📝 WalkthroughWalkthroughDocumentation updates to improve contributor onboarding. ONBOARDING.md adds guidance for first-time contributors, including backend service requirements and Firebase FCM testing instructions. README.md corrects two spelling errors. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~5 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom Pre-merge checks in the settings. 📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (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 |
|
I’ve opened a PR addressing this issue. Please let me know if any changes are needed. |
![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)
ONBOARDING.md (1)
19-20: Clarify the Firebase note's applicability for first-time contributors.The Firebase/FCM setup note, while detailed and technically accurate, immediately follows the "Without Full Backend" quick-start section. This placement may confuse readers about whether they should follow the instructions. The note opens with "new contributors do not have to setup firebase," but then provides detailed setup steps, which could seem contradictory.
Consider either:
- Moving the Firebase note to a separate, later section (e.g., after "Core Project Services Set Up") with a clearer heading like "Optional: Setting up Firebase for Notifications"
- Adding explicit context emphasizing that this is only for contributors who want to test FCM notifications and is entirely optional for other contribution types
This will help keep the quick-start section focused on the stated goal of avoiding setup complexity.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CONTRIBUTING.mdONBOARDING.mdREADME.md
🔇 Additional comments (2)
CONTRIBUTING.md (1)
57-70: First-Time Contributor Workflow section is clear and well-structured.The new section provides an accessible, step-by-step guide that is appropriately pitched for new contributors. The workflow is accurate (branching from
dev, targetingdevin PRs), and the encouragement to open discussions/issues when unsure is helpful. This directly supports the PR's goal of improving the onboarding experience.ONBOARDING.md (1)
7-17: Quick-Start section provides excellent guidance for first-time contributors.The section effectively communicates that backend setup is not required initially and provides concrete, achievable activities (Flutter code exploration, docs reading, dependency check, issue reporting). This directly addresses the PR's objective to help new contributors get started without full backend complexity.
| 2. Ability to create rooms and moderate speakers and events. | ||
| 3. Create Scheduled Rooms and notify subscribers as reminders to join | ||
| 4. Listen to and Stories as chapters with synced lyrics, browse through entire catalog of stories following your favourate creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progess) | ||
| 4. Listen to and Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progress) |
There was a problem hiding this comment.
Fix grammatical issue in feature description.
The phrase "Listen to and Stories as chapters..." is grammatically incomplete. It should likely read "Listen to Stories as chapters..." or similar.
🔎 Suggested correction
-4. Listen to and Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progress)
+4. Listen to Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progress)Alternatively, if "and" was intended to connect two actions:
-4. Listen to and Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progress)
+4. Create and listen to Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progress)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 4. Listen to and Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progress) | |
| 4. Listen to Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progress) |
| 4. Listen to and Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progress) | |
| 4. Create and listen to Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progress) |
🤖 Prompt for AI Agents
In README.md around line 48, the feature sentence "Listen to and Stories as
chapters with synced lyrics, browse through entire catalog of stories following
your favorite creators and waiting for their latest chapter/story releases. Post
your own stories having chapters. (work in progress)" is grammatically
incorrect; replace the fragment "Listen to and Stories as chapters..." with a
corrected phrase such as "Listen to Stories as chapters with synced lyrics..."
(or if two actions were intended, change to "Listen to and read Stories as
chapters with synced lyrics..."), and then ensure the rest of the sentence reads
smoothly (e.g., "Browse the entire catalog of stories, follow your favorite
creators to get updates on new chapter/story releases, and post your own
multi-chapter stories. (work in progress)").
|
I noticed there was an older issue (#587) focused on local setup versions. |
CONTRIBUTING.md
Outdated
| 6. Push your branch to your fork | ||
| 7. Open a Pull Request targeting the `dev` branch | ||
|
|
||
| If you are unsure about an issue, feel free to open a discussion or issue before starting. |
There was a problem hiding this comment.
Everything declared in this section already exists above
- Fork the repository and create your branch.
Line 28
We welcome contributions in the form of pull requests only to the
devbranch.
Line 26
- Make the necessary code changes or improvements in your branch.
- Ensure your code adheres to the project's coding style and guidelines.
- Document any relevant changes or updates in the project's documentation.
- Submit the pull request, providing a clear title and description of the changes made.
Line 29-32
- Engage in any feedback or discussions related to your pull request.
Line 33
ONBOARDING.md
Outdated
| - Running `flutter pub get` to understand dependencies | ||
| - Reporting build issues, documentation gaps, or UI inconsistencies | ||
|
|
||
| Backend setup (Appwrite, LiveKit, Meilisearch) is only required for contributors working on backend-dependent features. New contributors are encouraged to start small and gradually move to advanced areas. |
There was a problem hiding this comment.
This is factually untrue, the App will not run without setting up the Backend in some capacity
ONBOARDING.md
Outdated
| If you are a first-time contributor or GSoC aspirant, you do **not** need to set up the complete backend environment to start contributing. | ||
|
|
||
| You can begin by: | ||
| - Exploring the Flutter codebase (screens, controllers, routes, and UI) | ||
| - Reading documentation files like README.md, CONTRIBUTING.md, and ONBOARDING.md | ||
| - Running `flutter pub get` to understand dependencies | ||
| - Reporting build issues, documentation gaps, or UI inconsistencies |
There was a problem hiding this comment.
These points are also conveyed in CONTRIBUTING.md directly/indirectly
|
@M4dhav Thanks for the review. I’ve updated the PR to:
Please let me know if any further changes are needed. |
2 participants
Fixes #677
This PR improves the onboarding experience for first-time contributors by:
These changes aim to help new contributors get started without needing to set up the full backend.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.