Skip to content

Rule Files Sync #1

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.

Sign up for GitHub

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

Open
actual-ai-analyzer wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Rule Files Sync #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions packages/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## Project Structure & Module Organization

The repository follows a modular structure with clear separation between public APIs and internal implementation details.

## Build, Test, and Development Commands

- Build commands and test procedures should be documented as they are established
- Development workflow commands should be added as the repository evolves

## Coding Style & Naming Conventions

1. Use TypeScript for type-safe code
2. Follow existing naming conventions in each module
3. Use descriptive variable and function names
4. Add type definitions to formalize contracts between packages

## Architecture & Design Patterns

1. Establish explicit service definition boundaries for all public/external APIs by creating well-defined interface contracts, clear module exports, and separation between public API surfaces and internal implementation details. This pattern manifests through: (1) Dedicated API modules that expose only intended public functions, (2) Clear separation between internal utilities and external-facing services, (3) Consistent export patterns that signal API stability, (4) Type definitions that formalize the contract between packages, and (5) Structured service boundaries in codemods, AST manipulation, and core design system components. Files like design-system.ts, apply.ts, and ast.ts serve as public API entry points, while internal utilities like default-map.ts provide supporting infrastructure with controlled visibility.

## Testing Guidelines

1. Write unit tests for business logic
2. Include integration tests for critical functionality
3. Aim for meaningful test coverage of public APIs

## Commit & Pull Request Guidelines

1. Write clear, descriptive commit messages
2. Reference issue numbers in commits when applicable
3. Keep PRs focused and reviewable
4. Ensure tests pass before requesting review

## Security & Configuration Tips

1. Follow security best practices for dependency management
2. Keep configuration separate from code
3. Document any security-relevant decisions