docs: add CONTRIBUTING, AGENTS, and PR template - #8
Conversation
🤖 Generated with [Claude Code](https://claude.com/claude-code)
WalkthroughThis PR adds three documentation files: a GitHub PR template with a checklist, an AGENTS.md file describing repository conventions and workflow for contributors, and a CONTRIBUTING.md file documenting local setup, testing, and device-contribution processes. No code changes are included. ChangesContributor Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 5-7: Add a shell language tag to both fenced command blocks in the
contributing docs so markdownlint stops flagging them. Update the markdown
fences around the commands shown near the existing python and npm test commands,
and make sure both code blocks use the same explicit bash tag.
🪄 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: 190b088d-fb9f-44d2-a022-3ef94bbfe8c2
📒 Files selected for processing (3)
.github/PULL_REQUEST_TEMPLATE.mdAGENTS.mdCONTRIBUTING.md
| ``` | ||
| python -m http.server 8123 | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add a language tag to both fenced command blocks.
markdownlint already flags these blocks, so the docs will stay noisy until the fences declare the shell language.
🔧 Minimal fix
-```
+```bash
python -m http.server 8123
```diff
-```
+```bash
cd tests
npm ci
npx playwright test
</details>
Also applies to: 13-17
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.22.1)</summary>
[warning] 5-5: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</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.md around lines 5 - 7, Add a shell language tag to both fenced
command blocks in the contributing docs so markdownlint stops flagging them.
Update the markdown fences around the commands shown near the existing python
and npm test commands, and make sure both code blocks use the same explicit bash
tag.
</details>
<!-- fingerprinting:phantom:triton:quartz -->
<!-- cr-indicator-types:potential_issue -->
<!-- cr-comment:v1:be9e32548d20740d5c12954d -->
_Source: Linters/SAST tools_
<!-- This is an auto-generated comment by CodeRabbit -->
Contributor docs so PRs (human or agent) hit the repo's gotchas before CI does: CONTRIBUTING.md (local dev, tests, adding a device, deploy rules), AGENTS.md (same facts condensed for coding agents), and a minimal PR checklist template.
Prompted by #2 arriving before any of this existed.
🤖 Generated with Claude Code
Summary by CodeRabbit