docs: add community contract guidelines#18
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughA new COMMUNITY.md was added defining community contract submission guidelines (required repository layout, required files, naming conventions for folders, contract files, tests, and identifiers). CONTRIBUTING.md was edited to retarget the repository (repository name updates and links), add a "Community Contract Guidelines" section linking to COMMUNITY.md, adjust wording around maintainers and API-compatibility guidance, and update related anchors and GitHub links. Both changes are documentation-only. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 5-10: The table of contents link `[Question or
Problem?](`#question`)` is pointing to a non-existent fragment; update the
fragment target to match the actual heading id (for example change the link to
`[Question or Problem?](`#question-or-problem`)` or rename the section header to
`Question` to match `#question`) so in-page navigation works; edit the TOC entry
containing `[Question or Problem?](`#question`)` and ensure the corresponding
section header matches the fragment identifier.
🪄 Autofix (Beta)
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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 7b5b2838-83e5-4510-8d53-d3a5470f95e1
📒 Files selected for processing (2)
COMMUNITY.mdCONTRIBUTING.md
| - [Code of Conduct](#coc) | ||
| - [Question or Problem?](#question) | ||
| - [Issues and Bugs](#issue) | ||
| - [Feature Requests](#feature) | ||
| - [Community Contract Guidelines](#community-contracts) | ||
| - [Submission Guidelines](#submit) |
There was a problem hiding this comment.
Fix broken Table of Contents fragment link.
[Question or Problem?](#question) points to a missing fragment target, so in-page navigation is broken.
Proposed fix
-- [Question or Problem?](`#question`)
+- [Question or Problem?](`#issue`)📝 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.
| - [Code of Conduct](#coc) | |
| - [Question or Problem?](#question) | |
| - [Issues and Bugs](#issue) | |
| - [Feature Requests](#feature) | |
| - [Community Contract Guidelines](#community-contracts) | |
| - [Submission Guidelines](#submit) | |
| - [Code of Conduct](`#coc`) | |
| - [Question or Problem?](`#issue`) | |
| - [Issues and Bugs](`#issue`) | |
| - [Feature Requests](`#feature`) | |
| - [Community Contract Guidelines](`#community-contracts`) | |
| - [Submission Guidelines](`#submit`) |
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 6-6: Link fragments should be valid
(MD051, link-fragments)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CONTRIBUTING.md` around lines 5 - 10, The table of contents link `[Question
or Problem?](`#question`)` is pointing to a non-existent fragment; update the
fragment target to match the actual heading id (for example change the link to
`[Question or Problem?](`#question-or-problem`)` or rename the section header to
`Question` to match `#question`) so in-page navigation works; edit the TOC entry
containing `[Question or Problem?](`#question`)` and ensure the corresponding
section header matches the fragment identifier.
1 participant
This PR addresses the need for better organization and documentation for community smart contracts within the repository. Previously, there was no central index or structured guide, which could lead to disorganized ad-hoc submissions.
To encourage consistency and ease of future auditing, I have introduced specific community contract guidelines.
Changes Made:
Created
COMMUNITY.md: Added a new file that details instructions for submitting community contracts. This includes:
Folder Structure: Guidelines indicating that each new contract should reside in its own dedicated folder within the contracts/ directory.
Required Elements: Specifications that all new contracts must include a
README.md
, comprehensive tests in the test/ folder, and a valid
LICENSE.
Naming Conventions: Established rules utilizing PascalCase for folders/contracts and camelCase for variables/functions as per Solidity style guides.
Updated
CONTRIBUTING.md:
Corrected outdated references (changed "Kiijs library" to "Kii-solidity-contracts repository").
Added a new section for Community Contract Guidelines that links directly to the detailed instructions in
COMMUNITY.md.