docs: add repository guidelines and documentation - #31
Merged
kumawatkaran523 merged 6 commits intoAug 12, 2026
Conversation
WalkthroughUpdated repository documentation for SDK development, contribution, compliance tracking, maintainers, and brand usage. The checklist status now records 29 of 49 completed criteria. ChangesDevelopment and Contribution Guidance
Compliance Checklist Records
Maintainer and Brand References
Estimated code review effort: 1 (Trivial) | ~2 minutes 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 |
github-actions
Bot
added
no-issue-linked
Contributor
Atharva0506
marked this pull request as ready for review
August 10, 2026 15:03
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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 `@MAINTAINERS.md`:
- Around line 1-3: Update MAINTAINERS.md to keep its role references consistent:
if no Ideator is assigned, remove “Ideator” from the title and introduction;
otherwise add an Ideators section containing the required fields, matching the
existing Mentors and Maintainers structure.
- Around line 13-21: Synchronize the maintainer roster in README.md with the
canonical entries in MAINTAINERS.md: remove Bruno from the maintainer list,
retain Atharva, and add Karn and Aditya with their corresponding contact details
and focus. Alternatively, replace the existing README roster with a link to
MAINTAINERS.md.
🪄 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.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 3c995e7f-4863-4c01-b1c0-c604f873fecd
📒 Files selected for processing (1)
MAINTAINERS.md
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
AOSSIE-Org/ThruBox-Server(manual)
Atharva0506
changed the title
- Add brand/ kit (logos, generated favicons, color palette) with Brand.md - Fill in BestPracticesChecklist.md with objectively verifiable current state - Add AGENTS.md - Fix CONTRIBUTING.md template TODO placeholders and link the #thrubox Discord channel - Add README development/build/test instructions
github-actions
Bot
added
size/L
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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 `@BestPracticesChecklist.md`:
- Around line 34-35: Add the Markdown blank lines required by MD058 around the
score table near the Total row, and by MD022 after the “### SDK / Library Notes”
heading. Preserve all table content and surrounding documentation.
In `@brand/Brand.md`:
- Around line 29-39: Remove the “shared AOSSIE brand color” attribution from the
Lock Gold row in the Color Palette table, while retaining `#FFC517` as the padlock
accent sourced from thrubox-logo.svg; only keep the attribution if a canonical
AOSSIE source is added.
In `@CONTRIBUTING.md`:
- Around line 87-99: Update the numbered setup steps 3, 4, and 5 in
CONTRIBUTING.md by inserting a blank line between each step heading and its
fenced code block, resolving the MD031 markdownlint violations without changing
the commands.
🪄 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.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 5457edf6-1fd1-4117-8df1-9f835b5a6f8b
⛔ Files ignored due to path filters (8)
brand/aossie-logo.svgis excluded by!**/*.svgbrand/apple-touch-icon.pngis excluded by!**/*.pngbrand/favicon-16x16.pngis excluded by!**/*.pngbrand/favicon-32x32.pngis excluded by!**/*.pngbrand/favicon-48x48.pngis excluded by!**/*.pngbrand/favicon.icois excluded by!**/*.icobrand/icon-512.pngis excluded by!**/*.pngbrand/thrubox-logo.svgis excluded by!**/*.svg
📒 Files selected for processing (6)
AGENTS.mdBestPracticesChecklist.mdCONTRIBUTING.mdREADME.mdbrand/Brand.mdchecklist-status.json
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
AOSSIE-Org/ThruBox-Server(manual)
- MAINTAINERS.md: note no Ideators assigned instead of silently omitting the section - CONTRIBUTING.md: fix markdown formatting (blank lines around fenced code blocks) - BestPracticesChecklist.md: fix markdown formatting - brand/Brand.md: remove unverified 'shared AOSSIE brand color' attribution
adityabhattad2021
approved these changes
Aug 11, 2026
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
CONTRIBUTING.md (2)
71-104: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winAlign the package-manager instructions.
The prerequisites advertise
npm,yarn, andpnpm, but the setup steps provide onlynpm installandnpm run build. Add equivalent yarn and pnpm commands, or state that the documented workflow is npm-only.Proposed minimal fix
-- npm (or yarn/pnpm) +- npm (the setup commands below use npm)🤖 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` around lines 71 - 104, Align the package-manager prerequisites with the Setup commands in CONTRIBUTING.md: either add equivalent Yarn and pnpm install/build commands alongside the existing npm commands, or revise the prerequisites to state that the documented workflow is npm-only.
128-134: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse one package manager consistently in the setup instructions.
The prerequisites list
npm,yarn, andpnpm, but all setup and build commands usenpm. Document equivalent commands or state that npm is required.🤖 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` around lines 128 - 134, Update the setup and validation instructions in CONTRIBUTING.md to use one package manager consistently: either state that npm is required and remove conflicting yarn/pnpm prerequisites, or provide equivalent yarn and pnpm commands wherever npm commands are documented.BestPracticesChecklist.md (1)
216-218: 🔒 Security & Privacy | 🟡 Minor | ⚡ Quick winUse the CodeQL term
defaultquery suite.The workflow leaves
queriesunset. Update the checklist entry:Proposed wording
- - *Tool + ruleset:* CodeQL (`.github/workflows/codeql.yml`), default security query pack. + - *Tool + ruleset:* CodeQL (`.github/workflows/codeql.yml`), built-in `default` query suite.🤖 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 `@BestPracticesChecklist.md` around lines 216 - 218, Update the static_analysis_common_vulnerabilities checklist entry to explicitly call the CodeQL configuration the “default” query suite, matching the workflow’s unset queries configuration; preserve the existing tool and workflow references.
🤖 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.
Outside diff comments:
In `@BestPracticesChecklist.md`:
- Around line 216-218: Update the static_analysis_common_vulnerabilities
checklist entry to explicitly call the CodeQL configuration the “default” query
suite, matching the workflow’s unset queries configuration; preserve the
existing tool and workflow references.
In `@CONTRIBUTING.md`:
- Around line 71-104: Align the package-manager prerequisites with the Setup
commands in CONTRIBUTING.md: either add equivalent Yarn and pnpm install/build
commands alongside the existing npm commands, or revise the prerequisites to
state that the documented workflow is npm-only.
- Around line 128-134: Update the setup and validation instructions in
CONTRIBUTING.md to use one package manager consistently: either state that npm
is required and remove conflicting yarn/pnpm prerequisites, or provide
equivalent yarn and pnpm commands wherever npm commands are documented.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: d66f0cb8-9fd8-4bfa-a546-a51a4332c7b5
📒 Files selected for processing (4)
BestPracticesChecklist.mdCONTRIBUTING.mdMAINTAINERS.mdbrand/Brand.md
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
AOSSIE-Org/ThruBox-Server(manual)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addressed Issues:
N/A
Screenshots/Recordings:
N/A (documentation-only change)
Additional Notes:
Adds repository guidelines and documentation per AOSSIE's midterm repo-quality checklist:
MAINTAINERS.md— Mentors and Maintainers per AOSSIE's role definitionsbrand/kit — logo, generated favicons/icons,Brand.mddocumenting the color palette (sourced from the existing logo)BestPracticesChecklist.md— filled in with objectively verifiable current state (self-certification items left open for a maintainer)AGENTS.md— build/test/contribution instructions for AI coding agentsTODO/YOUR_USERNAME/TODO.gitplaceholders inCONTRIBUTING.md#thruboxDiscord channel inCONTRIBUTING.md(previously only the general server invite)Used Claude Code with model Claude Sonnet 5 to draft this documentation and generate the favicon assets.
Checklist
Summary by CodeRabbit