Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (49 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

61 lines (49 loc) · 1.56 KB

Contributing to @ainyc/aeo-audit

Getting Started

git clone https://github.com/Canonry/aeo-audit.git
cd aeo-audit
pnpm install
pnpm run typecheck
pnpm run build
pnpm test

Development

  • Language: TypeScript (ESM)
  • Node version: >= 20
  • Build output: dist/
  • Typecheck: tsc --noEmit
  • Test runner: tsx --test
  • Linter: ESLint v9 flat config

Adding a New Analyzer

  1. Create src/analyzers/your-analyzer.ts exporting a function: 
    export function analyzeYourFactor(context) {
  // context: { $, html, url, headers, auxiliary, structuredData, textContent, pageTitle }
  return {
    score: 0-100,
    findings: [{ type: 'found'|'missing'|'info'|'timeout'|'unreachable', message: '...' }],
    recommendations: ['...'],
  }
}
  2. Add the factor to FACTOR_DEFINITIONS in src/scoring.ts
  3. Wire it up in src/index.ts (import + add to ANALYZER_BY_ID)
  4. Add tests in test/analyzers/your-analyzer.test.ts
  5. Ensure all weights still sum to 100%

Running Tests

pnpm run typecheck
pnpm run build
pnpm test

Code Style

  • Functional style, no classes except AeoAuditError
  • Use clampScore() from helpers for all score calculations
  • Findings use types: found, missing, info, timeout, unreachable
  • Recommendations should be actionable and specific

Pull Requests

  • Include tests for new analyzers or bug fixes
  • Run pnpm run build if you change the CLI packaging or published entrypoints
  • Run pnpm lint before submitting
  • Keep PRs focused on a single change