[AAASM-427] 📝 (docs): Contributing guide refinements + Code of Conduct - #1053
[AAASM-427] 📝 (docs): Contributing guide refinements + Code of Conduct#1053Chisanan232 wants to merge 5 commits into
Conversation
Fill the empty CODE_OF_CONDUCT.md with the unmodified Contributor Covenant 2.1, contact substituted to security@agent-assembly.dev. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Chisanan232 <chi10211201@cycu.org.tw>
Add a Code of Conduct agreement notice and a pointer to the README Quickstart (make dev-setup / dev-verify) at the top of the guide. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Chisanan232 <chi10211201@cycu.org.tw>
Expand branch naming to the <release>/<ticket>/<type>/<summary> format and align the commit-style section to Conventional Commits + GitEmoji with a category table. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Chisanan232 <chi10211201@cycu.org.tw>
Add a Code Review section (author/reviewer expectations, merge criteria, squash-vs-rebase strategy) and clarify that every PR targets master and links the PR template. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Chisanan232 <chi10211201@cycu.org.tw>
Link the bug-report and feature-request templates, advise searching existing issues, and route security vulnerabilities to SECURITY.md instead of public issues. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Chisanan232 <chi10211201@cycu.org.tw>
🤖 Claude Code — PR reviewTicket: AAASM-427 — Author Contributing guide + Code of Conduct. CI — ✅ all green
Scope vs. acceptance criteria
Both files are fully delivered and validated. The ⏸️ items are docs-site-aggregation (genuinely dependent on AAASM-302) plus the standalone lychee CI job (AAASM-661), which can land as its own small change. Commits & lane — ✅ clean5 atomic, DCO-signed commits ( Note on authoringThe Code of Conduct is the canonical Contributor Covenant 2.1 fetched verbatim from contributor-covenant.org with only the ReadinessReady to merge pending one Pioneer-team approval. CI green, both files lint/link-clean, all file-level ACs met. Docs-site aggregation tracked under AAASM-655 / AAASM-302; lychee CI job under AAASM-661. Recorded as a review note; no formal approval submitted. |
|
🏷️ Held open — This documentation is written out in full detail and the review is green/ready, but the team is still deliberating on the documentation content/structure. Per maintainer decision, keep this PR open and do not merge until that discussion concludes. The — Claude Code |
Description
Refines the root
CONTRIBUTING.mdand fills the previously-emptyCODE_OF_CONDUCT.mdso the project has complete, accurate contributorgovernance docs. Implements AAASM-427.
CONTRIBUTING.md— kept all existing good content; added/expanded:issue reporting (with template links), four-part branch naming
(
<release>/<ticket>/<type>/<summary>), commit conventions aligned toConventional Commits + GitEmoji (with a category table), the PR
process (always base
master, links the PR template), a new CodeReview section (author/reviewer expectations, merge criteria, squash
vs rebase), the DCO sign-off requirement (already present, kept),
and a link to the README Quickstart for local-dev setup.
CODE_OF_CONDUCT.md— the unmodified Contributor Covenant 2.1,with the enforcement contact substituted to
security@agent-assembly.dev.Type of Change
Breaking Changes
Related Issues
Testing
markdownlint-cli2against the repo.markdownlint.json: 0 errors on both files.lychee --offline: 0 errors (all internal links — Code of Conduct, README#quickstart, PR/issue templates, SECURITY.md, LICENSE — resolve).Checklist
Follow-up (dependent, not in scope)
Aggregation of these files to the docs site
/contributing/page viarepository_dispatchdepends on the AAASM-302 docs-sync workflow,which is not yet present in the repo. Noted here rather than invented.