Skip to content

docs: add README, CLAUDE.md, LICENSE, .gitignore, and docs/#21

Closed
labrats-ai-agents[bot] wants to merge 2 commits into
mainfrom
docs/improve-repository-documentation
Closed

docs: add README, CLAUDE.md, LICENSE, .gitignore, and docs/#21
labrats-ai-agents[bot] wants to merge 2 commits into
mainfrom
docs/improve-repository-documentation

Conversation

@labrats-ai-agents
Copy link
Copy Markdown
Contributor

Summary

  • Add root-level README.md with Purpose, Structure, and Quick Start sections
  • Add CLAUDE.md with AI agent context and conventions for this repository
  • Add LICENSE (MIT)
  • Add .gitignore for OS/editor files
  • Add docs/workflow-templates.md documenting available workflow templates

Changes

File Action
README.md Created — describes repo purpose, structure, and how to use/add workflow templates
CLAUDE.md Created — key files, conventions, and agent roles for AI agents working here
LICENSE Created — MIT license
.gitignore Created — OS and editor ignores
docs/workflow-templates.md Created — documents the repo-info template and how to add new templates

Test plan

  • README renders correctly on the repository home page
  • CLAUDE.md accurately reflects the current repo state
  • docs/workflow-templates.md matches the actual template files in workflow-templates/

Closes #14

- README.md: purpose, structure, and quick-start for the .github repo
- CLAUDE.md: context and conventions for AI agents working here
- LICENSE: MIT license
- .gitignore: OS and editor ignores
- docs/workflow-templates.md: documents available templates and how to add new ones

Closes #14
@tomp736
Copy link
Copy Markdown
Contributor

tomp736 commented Mar 22, 2026

@ai-tom — Please review this PR. Check for correctness, adherence to org standards, and any issues. Approve if it looks good, or request changes with specific feedback.

@labrats-ai-agents
Copy link
Copy Markdown
Contributor Author

labrats-ai-agents Bot commented Mar 22, 2026

Thomas Pisula (@ai-tom) — Completed

Job: 583

@labrats-ai-agents
Copy link
Copy Markdown
Contributor Author

Thomas Pisula (@ai-tom) — In progress

Job: 583

@labrats-ai-agents
Copy link
Copy Markdown
Contributor Author

Reviewed. Content is accurate, minimal, and follows org conventions.

One nit: CLAUDE.md says agents are triggered by "GitHub issue labels" — they're actually triggered by @mentions in comments. Fix that line before merge.

Otherwise, good to go. @ai-developer please fix the CLAUDE.md agent-triggering description and merge.

@labrats-ai-agents
Copy link
Copy Markdown
Contributor Author

labrats-ai-agents Bot commented Mar 22, 2026

Developer (@ai-developer) — Completed

Job: 585

@labrats-ai-agents
Copy link
Copy Markdown
Contributor Author

Developer (@ai-developer) — In progress

Job: 585

Agents are triggered by @mentions in comments, not GitHub issue labels.

Closes feedback from PR #21 review.
@labrats-ai-agents
Copy link
Copy Markdown
Contributor Author

Fixed the CLAUDE.md nit: updated the agent trigger description from "triggered by GitHub issue labels" to "triggered by @mentions in issue and PR comments". Pushed to the PR branch.

@tomp736
Copy link
Copy Markdown
Contributor

tomp736 commented Mar 22, 2026

Superseded by #22.

@tomp736 tomp736 closed this Mar 22, 2026
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.

Documentation review requested

1 participant