Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (30 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

43 lines (30 loc) · 1.32 KB
Raw

Contributing

Thanks for considering a contribution to styles-iterator.

Good first contributions

  • Improve docs for real app setups, especially Next.js, Vite, Remix, and monorepos.
  • Add small CLI usability fixes with clear before/after behavior.
  • Tighten guard rails or error messages where the current output is ambiguous.
  • Add focused tests when changing command parsing, config loading, Git operations, or cleanup behavior.

Development setup

pnpm install --frozen-lockfile
pnpm build
node dist/cli.js --help

Run the full local validation before opening a pull request (typecheck, build, and smoke tests — the same command CI runs):

pnpm test

Pull request guidelines

  • Keep changes focused on one problem.
  • Include the command output or manual smoke test you used to verify the change.
  • Update README.md or CHANGELOG.md when behavior, commands, config, or release contents change.
  • Avoid adding dependencies unless they remove clear complexity or cover a real platform gap.

Reporting issues

When opening an issue, include:

  • your operating system
  • Node and pnpm versions
  • the command you ran
  • the relevant styles-iterator.config.* fields
  • the error output or session log path

Please do not file public issues for suspected security vulnerabilities. Use the process in SECURITY.md.