50 lines (41 loc) · 906 Bytes

Contributing

Thanks for contributing to docs-driven-api-updater.

Development Setup

Install dependencies:
```
npm install
```
Build:
```
npm run build
```
Typecheck:
```
npm run typecheck
```
Test:
```
npm run test
```

Coding Guidelines

TypeScript-first, ESM-only.
Keep changes minimal and focused.
Add JSDoc for exported functions.
Avoid introducing heavy dependencies.
Preserve safety constraints in update flow.

Pull Requests

Use descriptive PR titles.
Explain why the change is needed.
Include manual verification steps.
Keep generated artifacts out of commits when possible.

Release Process

Update version in package.json.
Update CHANGELOG.md.

Run:

npm run build && npm run typecheck && npm run test

Publish:
```
npm publish --access public
```