-
Notifications
You must be signed in to change notification settings - Fork 5
docs: add AI agent instructions #304
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Add new npm scripts for organized linting: - lint: Consolidated linting command that runs all checks - lint:format: Prettier formatting checks - lint:code: ESLint code quality checks This enables better organization of linting tasks and simplifies CI workflows. Assisted-by: GLM 4.6 via Claude Code
Replace redundant individual linting steps with consolidated npm run lint command. This streamlines the CI pipeline while maintaining the same code quality checks. Assisted-by: GLM 4.6 via Claude Code
Add comprehensive documentation for AI agents working with this codebase: - AGENTS.md: Complete project guidance for Claude Code and other AI agents - CLAUDE.md: Reference file that points to AGENTS.md Includes project overview, architecture details, development commands, content guidelines, and attribution requirements for AI-assisted work. Assisted-by: GLM 4.6 via Claude Code
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Greptile OverviewGreptile SummaryThis PR consolidates linting commands and adds AI agent documentation. The workflow simplification correctly replaces three separate lint commands with a single consolidated Key changes:
Minor issue found:
Confidence Score: 4/5
Important Files ChangedFile Analysis
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
4 files reviewed, 1 comment
Signed-off-by: Xe Iaso <[email protected]>
change header from '# CLAUDE.md' to '# AGENTS.md' to match filename. Assisted-by: GLM 4.6 via Claude Code
add guidance about using lowercase for commit body text to help maintain consistency. Assisted-by: GLM 4.6 via Claude Code
Signed-off-by: Xe Iaso <[email protected]>
This copies the general vibe of tigrisdata/tigris-os-docs#304, but is a bit more tailored to the blog's repo. Assisted-by: GLM 4.6 via Claude Code Signed-off-by: Xe Iaso <[email protected]>
Summary
This PR adds comprehensive documentation for AI agents working with the codebase and improves the build workflow organization.
Changes
AGENTS.mdandCLAUDE.mdwith detailed guidance for AI agentspackage.jsonFiles Added/Modified
AGENTS.md: Complete project guidance for Claude Code and other AI agentsCLAUDE.md: Reference file that points to AGENTS.mdpackage.json: Added organized linting scripts (lint,lint:format,lint:code).github/workflows/test.yaml: Streamlined CI pipelineBenefits
Test Plan
Closes TIG-6655
Assisted-by: GLM 4.6 via Claude Code