Contributing

OpenSyntax welcomes focused, practical contributions that improve terminal AI workflows without adding unnecessary complexity.

Clone and install

git clone https://github.com/itisuniqueofficial-gh/opensyntax.git
cd opensyntax
npm install

Development

npm run dev

Validation

npm run typecheck
npm run lint
npm test
npm run build

Focused tests

npx vitest run src/tests/tools.test.ts
npx vitest run src/tests/agent.test.ts

Coding standards

• Keep changes minimal and easy to review.
• Prefer typed tool schemas and explicit runtime checks.
• Do not log secrets or decrypted provider credentials.
• Keep README, docs, CLI help, and provider registry aligned.
• Use conventional commits such as `fix:`, `feat:`, `docs:`, `test:`, and `ci:`.

Pull request checklist

• Explain the problem and solution.
• Include validation commands run locally.
• Add tests for behavior changes when practical.
• Keep generated release commits out of feature branches.