๐Ÿค Contributing

February 17, 2026 ยท View on GitHub

Thanks for your interest in contributing to vue-router-citadel!

Requirements

  • Node.js >= 22.0.0
  • npm >= 9.0.0

Setup

git clone https://github.com/Kassaila/vue-router-citadel.git
cd vue-router-citadel
npm install

Quick Reference

npm run build          # Production build (ESM + CJS + types)
npm run test           # Run tests in watch mode
npm run test:run       # Run tests once
npm run test:coverage  # Coverage report
npm run lint           # ESLint check
npm run lint:fix       # ESLint auto-fix
npm run format         # Format code with Prettier
npm run check:all      # Full validation (format + lint + types + tests + build + size)

Full Guide

For detailed contributing guide, workflow, architecture guidelines, testing setup, and all test cases, see the Contributing Documentation.