docs(rules): run communication, PR, and review as rules#124
Conversation
Time Submission Status
Submit or update total time with: Add time on top of previous submission with: See available commands to help comply with our Guidelines. |
|
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 (17)
🚧 Files skipped from review as they are similar to previous changes (9)
WalkthroughThis PR establishes indexed, rules-based contributor documentation, adds developer rules and validation tooling, and configures a pinned ChangesDocumentation foundation
Developer rule catalog
Rule audit tooling
Push-time enforcement
Estimated code review effort: 3 (Moderate) | ~25 minutes Sequence Diagram(s)sequenceDiagram
participant Developer
participant GitHook as pre-push hook
participant Rumdl as local rumdl
participant RuleAudit as check-rules.mjs
Developer->>GitHook: push commits
GitHook->>Rumdl: lint changed Markdown
Rumdl-->>GitHook: report or apply fixes
GitHook->>RuleAudit: validate changed documentation
RuleAudit-->>GitHook: report audit result
GitHook-->>Developer: allow or block push
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 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 |
…ents # Conflicts: # docs/rules/DEV-040.md
zolotokrylin
left a comment
There was a problem hiding this comment.
@holdex pr add-time 2.4h
Updated the structure and naming conventions in the DEV-125 documentation. Signed-off-by: Vadim <1125014+zolotokrylin@users.noreply.github.com>
|
@holdex pr add-time 1.1h |
zolotokrylin
left a comment
There was a problem hiding this comment.
@holdex pr add-time 11m
Migrates the remaining CONTRIBUTING sections into the rules system and thins CONTRIBUTING to a link-only index. Consolidates the former #125 (Review) into this PR so there is a single PR to review instead of a stack.
New rules:
Communication (DEV-2xx)
DEV-210route discussion to the right channelDEV-220reference issues and PRs as list itemsPR requirements (DEV-3xx)
DEV-310sign every commitDEV-320scope a PR to a few hoursDEV-330keep docs in sync and each fact in one placeDEV-340name a PR for what users gainDEV-350mark a design PR docs(ui) with a Design sectionDEV-360follow the PR lifecycleDEV-370report time across all stagesDEV-380enforce markdown lint on push with a pinned rumdl hookReview (DEV-4xx)
DEV-410reject with Request Changes for objective problemsDEV-420scout open PRs when idleDEV-430deliver bug-free work; review is a safety checkDEV-330 also covers external and volatile facts: link a system's canonical docs instead of restating details that drift (DEV-140 links the Wizard command docs rather than hardcoding a command string).
Also wires up the lint enforcement so developers complies with DEV-380, mirroring partners/partnerships: a pinned
rumdldevDependency, apostinstallthat setscore.hooksPathto.githooks, and a.githooks/pre-pushthat runs the npm-pinned rumdl on changed markdown.node_modulesis gitignored. Verified end-to-end: the hook ran on this branch's push.CONTRIBUTING is now the thin narrative index over the rules, each section linking to its rules.
Summary by CodeRabbit
docs/index organized by audience and content type.