Add contributor, agent and brand documentation - #118
Conversation
|
Warning Review limit reached
Next review available in: 21 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
WalkthroughAdded repository guidance for contributors and AI coding agents, an OpenSSF-aligned practices checklist, updated README contribution links, and a canonical Fate Protocol brand guide. ChangesDocumentation and Guidance
Estimated code review effort: 1 (Trivial) | ~5 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 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 `@AGENTS.md`:
- Around line 35-37: Update the five-file chain checklist in AGENTS.md to
include src/utils/tokenList.ts, src/utils/rpcTransport.ts,
src/utils/supportedChainFeed.ts, and src/utils/explorer.ts, ensuring the
documentation reflects all required files for Ethereum Classic chain changes.
In `@BestPracticesChecklist.md`:
- Around line 129-130: Update the vulnerability_report_private checklist item in
BestPracticesChecklist.md to use [~] when private vulnerability reporting is not
supported, and add a justification stating that reports may be public; leave
vulnerability_report_process separately unmet, then recalculate and update all
affected summary values.
- Around line 115-119: Update the report_responses and enhancement_responses
checklist entries to avoid unsupported majority claims: provide reproducible
counts of applicable reports/requests and maintainer responses, or mark each
criterion unmet until sufficient evidence is available. Do not treat closed
issues as acknowledgments, and include a separate count for enhancement requests
and responses.
- Line 5: Remove the blank line inside the attribution blockquote in
BestPracticesChecklist.md, keeping all consecutive blockquote lines contiguous
so markdownlint MD028 no longer reports the issue.
In `@brand/Brand.md`:
- Around line 3-5: Clarify the animated logo’s source of truth in the brand
documentation: either add the missing canonical logo-animated.gif under brand/
and document its identical public/ mirror, or explicitly mark the public/ GIF as
non-canonical and specify how it is maintained.
In `@CONTRIBUTING.md`:
- Around line 22-25: Update the Node.js requirement in the “Install
dependencies” section of CONTRIBUTING.md to document the exact supported range
^18.18.0 || ^19.8.0 || >=20.0.0 instead of the broader “18 or later” wording.
🪄 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: 74be899c-296d-473a-9145-23485513c379
⛔ Files ignored due to path filters (5)
brand/apple-touch-icon.pngis excluded by!**/*.pngbrand/favicon.icois excluded by!**/*.icobrand/icon-192.pngis excluded by!**/*.pngbrand/icon-512.pngis excluded by!**/*.pngbrand/logo.svgis excluded by!**/*.svg
📒 Files selected for processing (5)
AGENTS.mdBestPracticesChecklist.mdCONTRIBUTING.mdREADME.mdbrand/Brand.md
2 participants
Summary
Adds the contributor, agent and brand documentation this repository was missing, plus the AOSSIE best practices checklist.
CONTRIBUTING.md— development setup, coding style, PR process. The README's Contributing section now links to it instead of duplicating it. The org-wide PR template links[Contribution Guidelines](../CONTRIBUTING.md), which had no target in this repo until now.AGENTS.md— the constraints that are easy to get wrong here: theout/.nextcollision, hand-maintained ABIs insrc/utils/abi/, the five files a chain addition touches, and the three numeric scales (base-token decimals, WAD,DENOMINATOR).BestPracticesChecklist.md— filled honestly at 33 of 49, counting justified N/A as met. Every unmet criterion carries a note on what closes it;warnings_fixedandtest_policyare the notable ones.brand/— mark, icons, andBrand.mdcovering logo usage, palette, typography and contrast. Bruno confirmed on 11 Aug that no brand guidelines existed, so these are newly authored. Every value is taken fromlogo.svgor the codebase rather than invented.Two deliberate choices worth flagging for review:
The
brand/assets are copies of thepublic/ones.public/is what the app serves andNavbar.tsximportspublic/logo.svgas a module, so those cannot move.AGENTS.mdrecords that the two locations must be updated together.Brand.mddocuments Geist as the brand typeface and notes that it is loaded vianext/fontbut never applied, becausetailwind.config.tsdoes not consume the CSS variables andglobals.csssets Arial. The two-line fix is deliberately excluded so that a change affecting every page is reviewed on its own.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:
Checklist
Summary by CodeRabbit