Agent Skills: Code Quality Workflow

Mandatory code quality workflow that must run after ANY code changes. Use after creating/editing files, before commits, or when fixing errors. Keywords - testing, linting, formatting, typecheck, quality gates, workflow.

UncategorizedID: jpmorgan-payments/embedded-finance/code-quality-workflow

Install this agent skill to your local

pnpm dlx add-skill https://github.com/jpmorgan-payments/embedded-finance/tree/HEAD/.github/skills/code-quality-workflow

Skill Files

Browse the full folder contents for code-quality-workflow.

Download Skill

Loading file tree…

.github/skills/code-quality-workflow/SKILL.md

Skill Metadata

Name
code-quality-workflow
Description
Mandatory code quality workflow that must run after ANY code changes. Use after creating/editing files, before commits, or when fixing errors. Keywords - testing, linting, formatting, typecheck, quality gates, workflow.

Code Quality Workflow

Mandatory code quality workflow ensuring all code meets standards before commits. This workflow runs automated type checking, formatting, linting, and testing.

When to Apply

Use this workflow:

  • After making ANY code changes
  • Before committing code
  • When fixing errors or issues
  • During code review preparation

⚠️ CRITICAL: Mandatory Steps

After making ANY code changes, you MUST:

  1. Format code: cd embedded-components; yarn format
  2. Run build: cd embedded-components; yarn build — required for substantive .ts/.tsx edits including tests/mocks (errors may not appear in Vitest alone).
  3. Run tests: cd embedded-components; yarn test
  4. Fix any errors that appear
  5. Re-run until all pass

Large changes (new components, refactors, many files): run yarn typecheck immediately before yarn build when you want an explicit extra gate:
yarn format; yarn typecheck; yarn build; yarn test.

Quick Reference

The Test Command

cd embedded-components
yarn test

This runs in sequence:

  1. typecheck - TypeScript type checking
  2. format:check - Prettier formatting verification
  3. lint - ESLint linting
  4. test:unit - Vitest unit tests

Quick Fix Commands

cd embedded-components

# Auto-fix formatting
yarn format

# Auto-fix linting
yarn lint:fix

# Check types only
yarn typecheck

# Full package build — run after substantive edits (including tests)
yarn build

# Run tests only
yarn test:unit

# Full test suite
yarn test

Typical sequence: yarn formatyarn buildyarn test. For large changes: yarn format, yarn typecheck, yarn build, yarn test.

Never Commit Code With

  • ❌ TypeScript errors
  • ❌ Build failures — run yarn build after edits (including tests)
  • ❌ Formatting errors (Prettier)
  • ❌ Linting errors
  • ❌ Failing tests

Coverage Requirements

  • ✅ Minimum 80% line coverage
  • ✅ All new code must have tests
  • ✅ Tests must be colocated with implementation
  • ✅ Use MSW for API mocking

How to Use

For detailed instructions, examples, and troubleshooting:

  • Full guide: AGENTS.md - Complete workflow documentation
  • Related skills:
    • test-and-fix-workflow - Systematic debugging workflow
    • component-testing - Testing patterns and examples

References

  • See embedded-components/package.json for all scripts
  • See AGENTS.md for complete workflow documentation
  • See embedded-components/CONTRIBUTING.md for contribution guidelines