-
Notifications
You must be signed in to change notification settings - Fork 5
Improve README with beginner-friendly contributiors. #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Added beginner-friendly sections to help new contributors and GSoC aspirants understand how to get started with AOSSIE.
📝 WalkthroughWalkthroughREADME.md expanded with three new sections: "Getting Started for New Contributors" providing onboarding steps, "Google Summer of Code (GSoC)" detailing participation recommendations, and "Important Files in This Repository" listing three referenced markdown documents. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
Pre-merge checks❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
🔇 Additional comments (2)
README.md (2)
6-31: Great addition—content is clear and beginner-friendly.The three new sections provide helpful structure for onboarding contributors and GSoC participants. The advice is practical, actionable, and aligns well with open-source best practices. Once the file references are verified, this will be a solid enhancement to the repository documentation.
6-31: All referenced files exist in the repository — no broken documentation links.
|
|
||
| Before contributing, please: | ||
| - Read the GoogleSummerOfCode.md file | ||
| - Go through the Communication Guidelines |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Clarify the reference to match the actual filename.
Line 13 says "Go through the Communication Guidelines" but the file listed later is CommunicationGuidelinesAndRules.md. Either update the reference text to match the actual filename or ensure consistency across the document.
🔎 Proposed fix
- - Go through the Communication Guidelines
+ - Read the CommunicationGuidelinesAndRules.md file📝 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.
| - Go through the Communication Guidelines | |
| - Read the CommunicationGuidelinesAndRules.md file |
🤖 Prompt for AI Agents
In README.md around line 13, the text "Go through the Communication Guidelines"
does not match the actual filename `CommunicationGuidelinesAndRules.md`; update
the reference so they are consistent—either change the sentence to explicitly
reference `CommunicationGuidelinesAndRules.md` (e.g., "Go through
CommunicationGuidelinesAndRules.md") or rename the linked filename/anchor
elsewhere to use "Communication Guidelines" consistently; ensure any link
targets or table-of-contents entries are updated to match the chosen wording.
This PR improves the README by adding clear guidance
for new contributors and GSoC aspirants.
No policy or rule changes included.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.