Skip to content

Add Testing section to README#3388

Open
SharpRake wants to merge 1 commit into
chainguard-dev:mainfrom
SharpRake:testing-overview
Open

Add Testing section to README#3388
SharpRake wants to merge 1 commit into
chainguard-dev:mainfrom
SharpRake:testing-overview

Conversation

@SharpRake
Copy link
Copy Markdown
Collaborator

Type of change

Documentation Update

  • Add a Testing section to the README explaining how draft content is verified before publication
  • Document accuracy review, local preview, pre-commit hooks, and deploy previews

What should this PR do?

resolves https://github.com/chainguard-dev/internal/issues/5865

Why are we making this change?

The README documented local development and contributing, but not how content is tested before it goes live. This section gives contributors and reviewers a shared understanding of the checks every draft passes through, including accuracy review and testing of any commands or code snippets.

What are the acceptance criteria?

  • The README includes a Testing section under Development
  • The section explains that content is reviewed for accuracy and that commands and code snippets are run and tested by both author and reviewer
  • The section describes local preview, pre-commit hooks, and Netlify deploy previews
  • The internal link to the Pre-commit Hooks section resolves correctly

How should this PR be tested?

  1. Check the preview link and ensure the changes look right
  2. Navigate to the README on the branch and confirm the new Testing section renders between Development and Contributing
  3. Confirm the "Pre-commit Hooks" link in the Testing section jumps to the correct heading

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Mark Drake <mark@chainguard.dev>
@SharpRake SharpRake requested a review from a team as a code owner June 5, 2026 19:58
@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 5, 2026

Deploy Preview for ornate-narwhal-088216 ready!

Name Link
🔨 Latest commit 330c3a2
🔍 Latest deploy log https://app.netlify.com/projects/ornate-narwhal-088216/deploys/6a232a6ff52ddf00085a47e0
😎 Deploy Preview https://deploy-preview-3388--ornate-narwhal-088216.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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