Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (23 loc) · 903 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 903 Bytes
Raw

Contributing to CogniDB

Thanks for helping improve secure NL→SQL tooling.

Please follow the Code of Conduct.

Setup

git clone https://github.com/boxed-dev/cognidb
cd cognidb
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pytest

Guidelines

  1. Prefer small, focused PRs.
  2. Add tests for security-sensitive changes under tests/security/.
  3. Do not weaken SELECT-only defaults without discussion.
  4. Keep dependencies lean — heavy ML stacks belong in optional extras.

Good first contributions

  • More security regression tests
  • Docs/examples for PostgreSQL and MySQL
  • SQLite driver for local demos
  • CI improvements

Releasing

Maintainers: bump version in pyproject.toml and cognidb/__init__.py, update CHANGELOG.md, tag vX.Y.Z, then python -m build && twine check dist/* and upload with a PyPI API token.