Skip to content

Conversation

@Xe
Copy link
Contributor

@Xe Xe commented Nov 12, 2025

Summary

This PR adds comprehensive documentation for AI agents working with the codebase and improves the build workflow organization.

Changes

  • Documentation: Add AGENTS.md and CLAUDE.md with detailed guidance for AI agents
  • Build: Add consolidated linting scripts to package.json
  • CI: Simplify GitHub Actions workflow to use new consolidated lint command

Files Added/Modified

  • AGENTS.md: Complete project guidance for Claude Code and other AI agents
  • CLAUDE.md: Reference file that points to AGENTS.md
  • package.json: Added organized linting scripts (lint, lint:format, lint:code)
  • .github/workflows/test.yaml: Streamlined CI pipeline

Benefits

  • Better organization of linting tasks
  • Simplified CI workflow while maintaining code quality checks
  • Comprehensive guidance for AI agents to work effectively with the codebase
  • Clear attribution requirements for AI-assisted work

Test Plan

  • Verify CI workflow runs successfully with new consolidated lint command
  • Confirm all linting checks (API docs, ESLint, Prettier) are properly executed
  • Test that documentation is accessible and accurate

Closes TIG-6655

Assisted-by: GLM 4.6 via Claude Code

Xe added 3 commits November 12, 2025 12:37
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
@vercel
Copy link

vercel bot commented Nov 12, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs-redirect Ready Ready Preview Comment Nov 12, 2025 5:48pm
tigris-os-docs Ready Ready Preview Comment Nov 12, 2025 5:48pm

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Nov 12, 2025

Greptile Overview

Greptile Summary

This PR consolidates linting commands and adds AI agent documentation. The workflow simplification correctly replaces three separate lint commands with a single consolidated npm run lint command that executes them in sequence (lint:apidocs, lint:code, lint:format).

Key changes:

  • Consolidated linting: Replaced individual npx prettier and npx eslint calls with organized npm scripts
  • AI agent guidance: Added comprehensive documentation for Claude Code and other AI agents working with the codebase
  • Attribution requirements: Established clear policy for AI-assisted contributions using "Assisted-by" commit footers

Minor issue found:

  • AGENTS.md:1 has incorrect header title (# CLAUDE.md instead of # AGENTS.md)

Confidence Score: 4/5

  • This PR is safe to merge with one minor syntax correction needed
  • The changes are well-structured and improve project organization. The workflow consolidation maintains all existing checks while improving maintainability. The only issue is a header mismatch in AGENTS.md that should be corrected before merging.
  • AGENTS.md requires attention for the header title correction

Important Files Changed

File Analysis

Filename Score Overview
.github/workflows/test.yaml 5/5 Simplified CI workflow to use consolidated npm run lint command, removing duplicate lint calls
package.json 5/5 Added organized linting scripts (lint, lint:format, lint:code) to consolidate code quality checks
AGENTS.md 4/5 Added comprehensive AI agent documentation with project overview, architecture, commands, and attribution requirements. Header title doesn't match filename.
CLAUDE.md 5/5 Reference file that redirects to AGENTS.md using @AGENTS.md syntax

Copy link
Contributor

@greptile-apps greptile-apps bot left a 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

Edit Code Review Agent Settings | Greptile

Xe added 2 commits November 12, 2025 12:42
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]>
Xe added a commit to tigrisdata/tigris-blog that referenced this pull request Nov 12, 2025
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]>
@Xe Xe changed the title Add AI agent documentation and improve build workflow docs: add AI agent instructions Nov 12, 2025
@Xe Xe merged commit df0d1a4 into main Nov 12, 2025
10 checks passed
@Xe Xe deleted the Xe/AGENTS.md branch November 12, 2025 18:22
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.

3 participants