docs(contributing): add and tailor contributing workflow for zenOS#35
docs(contributing): add and tailor contributing workflow for zenOS#35k-dot-greyz wants to merge 2 commits into
Conversation
…rchitecture guidelines
Reframe CONTRIBUTING.md for the standalone platform repo: clarify public docs vs dev-master-only guides, document repository layout, local quality gates aligned with zenos-ci, and submodule checkout notes.
📝 WalkthroughWalkthroughAdded ChangesContribution Guidelines and Standards
Estimated Code Review Effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
214-216: 💤 Low valueAdd language specifier to code block for better rendering.
The commit message format code block should specify a language identifier (e.g.,
textorplaintext) for improved syntax highlighting and rendering across different Markdown viewers.📝 Proposed fix
-``` +```text <type>(<scope>): <short summary></details> <details> <summary>🤖 Prompt for AI Agents</summary>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.mdaround lines 214 - 216, Update the Markdown code fence that
shows the commit message format so it includes a language specifier;
specifically change the opening fence for the block containing "():
" to include a language like "text" (e.g., use ```text) so the
code block renders with proper highlighting across Markdown viewers.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.Nitpick comments:
In@CONTRIBUTING.md:
- Around line 214-216: Update the Markdown code fence that shows the commit
message format so it includes a language specifier; specifically change the
opening fence for the block containing "(): " to
include a language like "text" (e.g., use ```text) so the code block renders
with proper highlighting across Markdown viewers.</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro **Run ID**: `12b4e515-be69-41e4-bd02-c4d19891ce9d` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between c86daf585b6907118d03c82f4f17b903cab22be2 and 15c6686f125ce0d4dd6965d69613b033d3efea61. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `CONTRIBUTING.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Summary
CONTRIBUTING.mdwith fork-and-PR workflow, GlitchWorks Agnostic Architecture Protocol, and pre-commit audit checklist.docs/vs dev-master-only guides, CI-aligned quality gates, and submodule checkout notes for monorepo contributors.Test plan
CONTRIBUTING.mdlinks resolve to existing paths (docs/AI_INSTRUCTIONS.md,.github/workflows/zenos-ci.yml, PR template, commit checklist).mainwith the committed contributing baseline at531615b.Note
Low Risk
Documentation-only change with no runtime, auth, or data-handling impact.
Overview
Introduces a new root
CONTRIBUTING.mdthat defines how to contribute to zenOS as a standalone product repo (with optionaldev-mastersubmodule context).The guide adds a zenOS vs dev-master boundary (platform code and public docs here; internal monorepo guides in the superproject), a repository layout table, a fork-and-PR workflow (remotes, branches,
gh pr create), CI-aligned local checks (black,isort,pytest, optionalruff/mypy), the GlitchWorks Agnostic Architecture Protocol (seven engineering rules), submodule contributor notes, a pre-commit audit checklist, and Conventional Commits examples.Reviewed by Cursor Bugbot for commit 15c6686. Configure here.
Summary by CodeRabbit