Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (55 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

83 lines (55 loc) · 1.78 KB

Contributing to TabAPI

Thanks for contributing. This guide keeps PRs fast to review and easy to merge.

Development setup

  1. Fork and clone the repository.
  2. Install dependencies:
npm ci
  1. Run typecheck and tests:
npm run typecheck
npm test
  1. Build the project:
npm run build
  1. Run the CLI locally:
npm run dev -- --help

Branch and PR workflow

  1. Create a focused branch from main.
  2. Keep each PR scoped to one logical change.
  3. Include tests for behavior changes.
  4. Update docs when CLI behavior or output changes.
  5. Open a PR with clear context and examples.

PR checklist

  • Code compiles with npm run build
  • Typecheck passes with npm run typecheck
  • Tests pass with npm test
  • New logic includes tests where practical
  • Public-facing changes are documented

Code style

  • Use TypeScript and existing project patterns.
  • Prefer explicit names over short abbreviations.
  • Keep functions small and composable.
  • Avoid unrelated refactors in feature/fix PRs.
  • Preserve local-first and secure-by-default behavior.

Commit messages

Use clear, imperative commit messages.

Examples:

  • add OpenAPI schema fallback for unknown payloads
  • fix replay diff summary when response body is empty
  • improve mcp serve error message for missing session

Reporting issues

Use the GitHub issue templates:

  • Bug report for reproducible defects
  • Feature request for new capabilities

Include exact commands, expected output, and actual output.

Security

If you discover a security-sensitive issue, avoid posting secrets or exploit details publicly. Open an issue with minimal reproduction details and maintainers will follow up.

License

By contributing, you agree that your contributions are licensed under the MIT License.