Thanks for contributing to outscraper-cli.
Requirements:
- Node.js 18+
- npm
Install dependencies:
npm ciBuild the CLI:
npm run buildRun the built CLI locally:
node dist/index.js --helpsrc/- TypeScript source codedist/- compiled build outputtemplates/- starter project templates copied byoutscraper initskills/- bundled skills used byoutscraper setup skills
- Create a branch for your change.
- Make changes in
src/,templates/, orskillsas needed. - Run:
npm test
npm run build- Verify the relevant CLI command manually.
- Open a pull request with a clear summary of the change.
- Prefer small, focused pull requests.
- Update
README.mdwhen user-facing behavior changes. - Do not edit generated output manually unless required for verification.
- Prefer changing source files in
src/; build output should be generated from source. - Keep CLI error messages actionable and concrete.
Current test coverage is minimal, so manual verification is important.
At minimum, validate:
outscraper --help- the command you changed
npm publish --dry-runif packaging behavior changed
Use semantic versioning:
- patch for fixes and small UX improvements
- minor for new commands or new CLI capabilities
- major for breaking CLI changes