Skip to content

AGENTS.md

Latest commit

 

History

History
57 lines (36 loc) · 1.86 KB

AGENTS.md

File metadata and controls

57 lines (36 loc) · 1.86 KB

AI Agents

This document tracks AI agents and their contributions to the oxc-sourcemap project.

Purpose

This file serves to:

  • Document AI agent contributions to the project
  • Provide transparency about automated contributions
  • Track the evolution of AI-assisted development in this codebase

Build Instructions

To build and develop this project, you'll need:

Prerequisites

Initial Setup

just init has already been run, all tools (typos-cli, cargo-shear, dprint) are already installed, do not run just init.

Rust and cargo components clippy, rust-docs and rustfmt has already been installed, do not install them.

Development Workflow

# Run all checks (recommended before committing)
just ready

# Format code
just fmt

# Individual commands
cargo check --all-targets --all-features  # Check compilation
cargo test                                # Run tests
cargo clippy --all-targets --all-features # Run linter
typos                                     # Check for typos

The just ready command runs a comprehensive check including git status verification, spell checking, compilation checks, tests, linting, and formatting.

Guidelines for AI Agent Contributions

When AI agents contribute to this project:

  1. Transparency: All AI-generated contributions should be clearly documented
  2. Review: AI contributions must undergo the same review process as human contributions
  3. Quality: AI contributions must meet the same quality standards as human contributions
  4. Attribution: Significant AI contributions should be properly attributed

Contact

For questions about AI agent contributions or this documentation, please open an issue in the repository.