feat: adding suggested maintainers.md and fixing rendering issues in readme.md - #13
Conversation
WalkthroughThe changes add contribution and OpenSSF checklist documentation, update README presentation and links, disable dynamic locale parameters, and correct the sitemap fallback-domain comment. ChangesRepository documentation
Locale routing configuration
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 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 |
reach2saksham
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@MAINTAINERS.md`:
- Line 27: Ensure MAINTAINERS.md ends with exactly one newline character after
the final contribution guidance sentence, resolving the markdownlint MD047
violation without changing the document content.
- Line 27: Resolve the broken contribution-guide reference in MAINTAINERS.md by
either adding the missing CONTRIBUTING.md file or updating the link to the
repository’s existing contribution guide. Ensure the resulting relative link
points to a valid document before submission.
In `@README.md`:
- Around line 8-13: Replace the placeholder branding in the README’s centered
logo and AOSSIE badge blocks: update the logo asset and alt text, badge project
name and label, and linked URL to the actual project values, or remove those
blocks entirely if no branding is available.
In `@src/app/sitemap.ts`:
- Line 10: Update the fallback domain used by the sitemap and its accompanying
comment to the valid production origin https://project.aossie.org, matching the
existing README.md documentation. Ensure all three references use the same
domain consistently when NEXT_PUBLIC_SITE_URL is unset.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: d11f53ff-c3f5-4062-bc8a-1ae06ad988a2
📒 Files selected for processing (4)
MAINTAINERS.mdREADME.mdsrc/app/[locale]/layout.tsxsrc/app/sitemap.ts
|
|
||
| ## 📜 Contribution Guidelines | ||
|
|
||
| Please read our [`CONTRIBUTING.md`](CONTRIBUTING.md) and [`DCO.md`](DCO.md) before submitting pull requests. All contributions are welcome! No newline at end of file |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add the required final newline.
markdownlint-cli2 reports MD047 on Line 27. End MAINTAINERS.md with exactly one newline character.
🧰 Tools
🪛 markdownlint-cli2 (0.23.2)
[warning] 27-27: Files should end with a single newline character
(MD047, single-trailing-newline)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@MAINTAINERS.md` at line 27, Ensure MAINTAINERS.md ends with exactly one
newline character after the final contribution guidance sentence, resolving the
markdownlint MD047 violation without changing the document content.
Source: Linters/SAST tools
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the CONTRIBUTING.md link before merge.
The repository context indicates that CONTRIBUTING.md is not present. Contributors will reach a dead relative link. Add the file or change the link to the correct contribution guide.
🧰 Tools
🪛 markdownlint-cli2 (0.23.2)
[warning] 27-27: Files should end with a single newline character
(MD047, single-trailing-newline)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@MAINTAINERS.md` at line 27, Resolve the broken contribution-guide reference
in MAINTAINERS.md by either adding the missing CONTRIBUTING.md file or updating
the link to the repository’s existing contribution guide. Ensure the resulting
relative link points to a valid document before submission.
|
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Line 17: Apply markdownlint spacing fixes: in CONTRIBUTING.md, add required
blank lines around the “Prerequisites” heading (17-17), before the “Fork &
Clone” fence (21-22), before “Install Dependencies” (27-28), around the
development-server fence (32-35), and around the pull-request fences (43-52); in
BestPracticesChecklist.md, remove the blank line inside the opening blockquote
(5-5), add blank lines after the score table (34-35) and Web3 (242-243),
Full-Stack / Next.js (247-248), and AI / LLM (251-252) headings, and ensure the
file ends with exactly one newline (258-258).
- Line 11: Correct the misspelled “Discrod Channel” label in the contribution
instructions to “Discord Channel,” leaving the surrounding channel and server
references unchanged.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: e580564c-5a9d-4aa0-a3cc-9d1befe44b74
📒 Files selected for processing (2)
BestPracticesChecklist.mdCONTRIBUTING.md
|
|
||
| If you have questions, feedback, or want to discuss ideas before building: | ||
| - **AOSSIE Discord Server:** [https://discord.gg/hjUhu33uAn](https://discord.gg/hjUhu33uAn) | ||
| - **Discrod Channel:** `#TODO: Channel Name` channel in the TODO:Project Discord server |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Correct the Discord label.
Discrod Channel is misspelled. Change it to Discord Channel.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.md` at line 11, Correct the misspelled “Discrod Channel” label
in the contribution instructions to “Discord Channel,” leaving the surrounding
channel and server references unchanged.
|
|
||
| ## 🛠️ Getting Started | ||
|
|
||
| ### 1. Prerequisites |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Apply the Markdown formatting fixes reported by markdownlint.
CONTRIBUTING.md#L17-L17: add blank lines around thePrerequisitesheading.CONTRIBUTING.md#L21-L22: add a blank line before theFork & Clonecode fence.CONTRIBUTING.md#L27-L28: add a blank line before theInstall Dependenciescode fence.CONTRIBUTING.md#L32-L35: add blank lines around the development-server code fence.CONTRIBUTING.md#L43-L52: add blank lines around the pull-request code fences.BestPracticesChecklist.md#L5-L5: remove the blank line inside the opening blockquote.BestPracticesChecklist.md#L34-L35: add a blank line after the score table.BestPracticesChecklist.md#L242-L243: add a blank line after the Web3 heading.BestPracticesChecklist.md#L247-L248: add a blank line after the Full-Stack / Next.js heading.BestPracticesChecklist.md#L251-L252: add a blank line after the AI / LLM heading.BestPracticesChecklist.md#L258-L258: terminate the file with exactly one newline.
🧰 Tools
🪛 markdownlint-cli2 (0.23.2)
[warning] 17-17: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
📍 Affects 2 files
CONTRIBUTING.md#L17-L17(this comment)CONTRIBUTING.md#L21-L22CONTRIBUTING.md#L27-L28CONTRIBUTING.md#L32-L35CONTRIBUTING.md#L43-L52BestPracticesChecklist.md#L5-L5BestPracticesChecklist.md#L34-L35BestPracticesChecklist.md#L242-L243BestPracticesChecklist.md#L247-L248BestPracticesChecklist.md#L251-L252BestPracticesChecklist.md#L258-L258
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.md` at line 17, Apply markdownlint spacing fixes: in
CONTRIBUTING.md, add required blank lines around the “Prerequisites” heading
(17-17), before the “Fork & Clone” fence (21-22), before “Install Dependencies”
(27-28), around the development-server fence (32-35), and around the
pull-request fences (43-52); in BestPracticesChecklist.md, remove the blank line
inside the opening blockquote (5-5), add blank lines after the score table
(34-35) and Web3 (242-243), Full-Stack / Next.js (247-248), and AI / LLM
(251-252) headings, and ensure the file ends with exactly one newline (258-258).
Source: Linters/SAST tools
2 participants
Small Improvements that I will keep on adding for sometime before merging this PR.
Additional Notes:
AI Usage Disclosure:
We encourage contributors to use AI tools responsibly when creating Pull Requests. While AI can be a valuable aid, it is essential to ensure that your contributions meet the task requirements, build successfully, include relevant tests, and pass all linters. Submissions that do not meet these standards may be closed without warning to maintain the quality and integrity of the project. Please take the time to understand the changes you are proposing and their impact. AI slop is strongly discouraged and may lead to banning and blocking. Do not spam our repos with AI slop.
Check one of the checkboxes below:
I have used the following AI models and tools: TODO
Checklist
Summary by CodeRabbit