Skip to content

Docs: add agent and contributor guidance - #337

Merged
jackspiering merged 2 commits into
mainfrom
docs/agent-contributing-guidance
Sep 11, 2026
Merged

jackspiering merged 2 commits into
mainfrom
docs/agent-contributing-guidance

Conversation

@jackspiering

@jackspiering jackspiering commented Sep 10, 2026

Copy link
Copy Markdown
Collaborator

Description

Add concise repository guidance for coding agents and clarify the contributor workflow.

The contributor guide now covers template copying, sidecar requirements, ports, health checks, persistent data, documentation, and verification. The agent guide adds focused editing and reporting instructions.

This change affects documentation only.

Related Issues

  • None.

Verification

rumdl check --config .markdownlint.yml AGENTS.md CONTRIBUTING.md
Success: No issues found in 2 files

git diff --check origin/main...HEAD

Checklist

  • I have performed a self-review of my changes.
  • I have added relevant verification.
  • I have updated the necessary documentation.
  • I have selected the correct label(s) for this PR.

@jackspiering
jackspiering force-pushed the docs/agent-contributing-guidance branch from 1d681cd to 38f5f92 Compare September 10, 2026 16:51
@jackspiering
jackspiering marked this pull request as ready for review September 11, 2026 10:19
@jackspiering
jackspiering merged commit 439c79e into main Sep 11, 2026
1 check passed
@jackspiering
jackspiering deleted the docs/agent-contributing-guidance branch September 11, 2026 10:20
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.

2 participants