ajy/AGENTS.md

Agent Guidelines

Project Overview

Minimal placeholder repository. No build system, no source code yet. Two Chinese-named directories:

• 模版文件/ — Template files (currently empty)
• 需求材料/ — Requirement materials (contains 艾灸椅功能定义-最新.xlsx — moxibustion chair feature spec)

Build / Lint / Test Commands

None configured. This repo has no package.json, Makefile, pyproject.toml, or any build configuration.

When a project is added, document commands here. Common patterns:

# Node.js / npm
npm install          # install deps
npm run dev          # dev server
npm run build        # production build
npm test             # run all tests
npm test -- --testPathPattern=filename  # single test

# Python
pip install -r requirements.txt
pytest tests/test_file.py::TestClass::test_method  # single test
pytest -k test_name   # single test by name

# Go
go build ./...
go test -run TestName ./...

# Rust
cargo build
cargo test test_name

Code Style Guidelines

No code exists yet. When adding code, follow these defaults unless project-specific configs dictate otherwise:

Imports

• Group: stdlib → third-party → local
• Sort alphabetically within groups
• Use explicit imports, no wildcards

Formatting

• Match existing file indentation (2 or 4 spaces)
• Max line length: 80-120 chars
• Consistent line endings (CRLF on Windows, LF elsewhere)

Naming

• Files: kebab-case or PascalCase
• Classes: PascalCase (UserService)
• Functions/Vars: camelCase (getUserById)
• Constants: SCREAMING_SNAKE_CASE (MAX_RETRIES)
• Booleans: is/has/should prefix (isActive)

Error Handling

• Use specific error types, not generic
• Include context in error messages
• Never silently swallow errors

Types (if TypeScript)

• Explicit annotations on params and returns
• Avoid any — use unknown if truly unknown
• Enable strict mode

Working with This Repository

1. Read first — Always check existing files before editing
2. Understand domain — Review requirement materials before implementing
3. Follow conventions — Match whatever pattern the added project uses
4. Test changes — Run appropriate tests when available
5. Commit responsibly — Atomic, focused commits with clear messages

Git Conventions

• Feature branches for new work
• Atomic commits with clear messages
• Run linters before committing (once configured)
• Review changes before pushing

Security

• Never commit secrets, API keys, or credentials
• Use environment variables for sensitive config
• Validate and sanitize all user inputs

Cursor / Copilot Rules

No Cursor rules (.cursorrules, .cursor/rules/) or Copilot instructions (.github/copilot-instructions.md) found.