Skip to content

docs: add contribution guide and BMAD workflow#147

Merged
stephenleo merged 7 commits intomainfrom
docs/contribution-guide
Apr 5, 2026
Merged

docs: add contribution guide and BMAD workflow#147
stephenleo merged 7 commits intomainfrom
docs/contribution-guide

Conversation

@stephenleo
Copy link
Copy Markdown
Owner

Summary

  • Adds a contribution guide explaining CI checks and how to pass them
  • Documents both the BMAD-assisted workflow and the manual workflow for adding new modules
  • Adds guidance for updating documentation, showcase, and examples

Test plan

  • Review guide content for accuracy against current CI setup
  • Verify BMAD workflow steps reflect current skill names
  • Confirm manual module workflow matches CLAUDE.md patterns

🤖 Generated with Claude Code

stephenleo and others added 6 commits April 5, 2026 08:09
Closes #116

Adds CONTRIBUTING.md at the repo root (auto-surfaced by GitHub on new
PRs/issues) and a matching docs/contributing.md page, both explaining
the four commands contributors must run before opening a PR:
cargo fmt, cargo clippy, cargo test, cargo build --release.

Also adds a one-liner to README.md and wires the new page into the
VitePress nav and sidebar. Fixes a pre-existing stray backtick on the
Material Hex showcase image.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude
Copy link
Copy Markdown

claude bot commented Apr 5, 2026

Code review

Found 2 issues. See inline comments below.


Issue 1 — docs/contributing.md lines 40–42: "no other files required" contradicts the next bullet

Line 40 says — no other files required immediately before line 42 instructs contributors to also edit src/config.rs. A contributor reading this literally would skip the config step. Per CLAUDE.md L18–19, adding a module involves the module file + src/modules/mod.rs, but src/config.rs is also required when the module needs config fields (which every module does).

Issue 2 — CONTRIBUTING.md lines 42–44: same contradiction + mirror is out of sync

Same "no other files required" problem as above. Additionally, both files state they are kept in sync manually, but docs/contributing.md has an extra bullet that CONTRIBUTING.md is missing:

Absent data → explicit match + tracing::warn! + None. Disabled flag → silent None. (Exception: context_bar renders an empty bar with tracing::debug! when context data is absent — this is intentional UX.)

This rule is defined in CLAUDE.md L9 and should appear in both contributing guides.

…manual-only

- Clarify module creation steps: config fields require src/config.rs update
- Sync absent-data/disabled-flag rule into CONTRIBUTING.md (was missing)
- Change claude-code-review workflow to manual dispatch with pr_number input

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@stephenleo stephenleo merged commit 8d33538 into main Apr 5, 2026
3 checks passed
@stephenleo stephenleo deleted the docs/contribution-guide branch April 5, 2026 02:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant