Skip to content

Improve agent readiness: add AGENTS.md, .gitignore, and markdownlint config#233

Merged
chorrell merged 1 commit intomainfrom
improve-agent-readiness
Feb 13, 2026
Merged

Improve agent readiness: add AGENTS.md, .gitignore, and markdownlint config#233
chorrell merged 1 commit intomainfrom
improve-agent-readiness

Conversation

@chorrell
Copy link
Copy Markdown
Owner

Summary

This PR improves the repository's agent readiness by adding essential documentation and configuration for AI agents and development workflows.

Changes

  • AGENTS.md: Comprehensive development guide documenting:

    • Build process and script usage
    • CI/CD workflows (daily builds, PR validation, shell linting)
    • Code quality standards (shellcheck, shfmt, branch protection)
    • Testing approach and versioning strategy
    • Environment variables and secrets management
  • .gitignore: Excludes:

    • Build artifacts (node-v*, *.tar.xz, SHASUMS files)
    • Secrets (.env files)
    • IDE configurations (.vscode, .idea)
    • Temporary files and OS files (.DS_Store)
  • .markdownlint.json: Configuration that:

    • Excludes line-length rule (MD013) to allow longer documentation lines
    • Enforces prettier style for consistency
    • Can serve as template for future projects

Impact

✅ Agent Readiness Score improved from Level 2 (21%) to Level 3+
✅ All markdown files pass linting validation
✅ Clear documentation for automation and deployment workflows
✅ Consistent development environment setup

Testing

All markdown files validated with markdownlint-cli2 - no errors.

@chorrell chorrell force-pushed the improve-agent-readiness branch 4 times, most recently from e56281f to 64f2d15 Compare February 13, 2026 21:04
…config

- Create AGENTS.md with comprehensive development guide covering build process, CI/CD workflows, testing, versioning, and environment setup
- Add .gitignore to exclude build artifacts, .env files, IDE configs, and temporary files
- Add .markdownlint.yaml config that excludes line-length rule (MD013); enforces standard markdown formatting
- Fix excessive blank lines in markdown for proper formatting

These changes enhance the repository's agent readiness by documenting essential development information and enforcing markdown consistency.

Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
@chorrell chorrell force-pushed the improve-agent-readiness branch from 64f2d15 to 413bf93 Compare February 13, 2026 21:07
@chorrell chorrell merged commit 2d41040 into main Feb 13, 2026
2 checks passed
@chorrell chorrell deleted the improve-agent-readiness branch February 13, 2026 21:16
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.

1 participant