Skip to content

Add CLAUDE.md with pre-PR check playbook#4916

Open
btshrewsbury-viam wants to merge 1 commit intonew-docs-sitefrom
claude-md-playbook
Open

Add CLAUDE.md with pre-PR check playbook#4916
btshrewsbury-viam wants to merge 1 commit intonew-docs-sitefrom
claude-md-playbook

Conversation

@btshrewsbury-viam
Copy link
Copy Markdown

Summary

  • Adds CLAUDE.md at the repo root documenting the four required pre-PR checks (prettier, markdownlint, vale, make build-prod) with ordering rationale and an optional browser spot-check step.
  • Intended as a handoff document for new contributors (and for Claude) so the checks get run consistently before a PR is opened.

Test plan

  • Reviewer to confirm the commands and ordering match current tooling expectations.
  • Reviewer to confirm the repo-root location is preferred vs. a subdirectory.

🤖 Generated with Claude Code

Document the four required pre-PR checks (prettier, markdownlint, vale,
make build-prod) along with ordering rationale and an optional
browser spot-check step so Claude (and new contributors) run them
consistently before submitting a PR.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 13, 2026

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit d26ed16
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/69dd1f2923893a0008536fa2
😎 Deploy Preview https://deploy-preview-4916--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 43 (🔴 down 2 from production)
Accessibility: 99 (🔴 down 1 from production)
Best Practices: 92 (no change from production)
SEO: 89 (🔴 down 3 from production)
PWA: 60 (🔴 down 10 from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

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