Contributing¶
- Branch from
main; open a pull request. CI must be green. -
Before pushing:
uv run ruff check src tests scripts && uv run ruff format --check src tests uv run mypy --strict src uv run pytest python scripts/record_fixtures.py check python scripts/gen_tools_reference.py && python scripts/gen_config_reference.py python scripts/gen_llms_txt.py && python scripts/okf_validate.py docs -
Documentation follows OKF v0.2 (see
AGENTS.md): frontmatter on every content page, no frontmatter on sectionindex.mdfiles, a dated entry indocs/log.md, and the generated files committed.
Two change logs¶
CHANGELOG.md(repository root) is the package release log, in the Keep a Changelog format1.docs/log.mdis the OKF log of the documentation bundle; each release adds one "docs for neon-mcp vX.Y.Z" entry.
Versioning and releases¶
neon-mcp follows Semantic Versioning2 from 0.1.0. The version lives in
src/neon_mcp/__init__.py. Pushing a vX.Y.Z tag runs .github/workflows/release.yml:
tests, uv build, PyPI trusted publishing and a GitHub release with the artifacts.
-
Keep a Changelog 1.1.0. https://keepachangelog.com/en/1.1.0/ ↩
-
Semantic Versioning. https://semver.org/ ↩