Skip to content

MacHu-GWU/sqlalchemy_upsert_kit-project / .claude/skills/pywf-oss-base

pywf-oss-base

Flagged

Shared conventions, references, and scripts of the pywf-oss skills for pywf open-source Python libraries: setup, layout, code style, tests, user docs and the agent skills that hold API and maintenance knowledge, CI and hosting, release, dependencies, and secrets. Load it before ad-hoc work on modules, tests, or docs in such a repo, for a question about these conventions, or when unsure which pywf-oss skill fits a job.

FileKindSize
SKILL.mdskill md6.5 KB
assets/community-skills.tomlconfig2.4 KB
assets/notebook-page-template.ipynbother1.1 KB
assets/raw-rst-cell.jsonconfig255 B
references/00-authoring-references.mdmarkdown6.3 KB
references/01-secrets.mdmarkdown3.0 KB
references/02-machine-setup.mdmarkdown3.2 KB
references/03-mise.mdmarkdown2.1 KB
references/04-python-versions.mdmarkdown1.8 KB
references/05-uv-dependencies.mdmarkdown2.0 KB
references/06-ruff.mdmarkdown1.9 KB
references/07-repo-layout.mdmarkdown2.3 KB
references/08-package-files.mdmarkdown3.9 KB
references/09-code-style.mdmarkdown5.6 KB
references/10-test-layout.mdmarkdown4.1 KB
references/11-test-writing.mdmarkdown2.1 KB
references/12-coverage.mdmarkdown1.1 KB
references/13-sphinx.mdmarkdown5.6 KB
references/14-docfly.mdmarkdown2.2 KB
references/15-furo.mdmarkdown1.4 KB
references/16-sphinx-design.mdmarkdown5.8 KB
references/17-nbsphinx.mdmarkdown5.0 KB
references/18-knowledge-channels.mdmarkdown3.8 KB
references/19-github-actions.mdmarkdown3.7 KB
references/20-codecov.mdmarkdown1.3 KB
references/21-readthedocs.mdmarkdown1.7 KB
references/22-versioning-and-changelog.mdmarkdown3.0 KB
references/23-release.mdmarkdown1.3 KB
references/24-dependency-upgrades.mdmarkdown3.2 KB
references/25-python-release-cycle.mdmarkdown1.4 KB
references/26-community-skills.mdmarkdown5.0 KB
references/27-skill-family-workflow.mdmarkdown6.5 KB
scripts/check_doc_xrefs.pyscript3.4 KB
scripts/check_one_import_per_line.pyscript4.2 KB
scripts/check_skill_family.pyscript6.5 KB
scripts/check_test_layout.pyscript6.2 KB
scripts/install_community_skill.pyscript8.6 KB
scripts/update_skill_index.pyscript4.1 KB

references/22-versioning-and-changelog.md

View on GitHub
---
description: "Semantic versioning judged against api.py, where the version lives, and the release-history.rst changelog: its format, the untouchable Backlog section, category order and which change goes where, and plain-text entries. Read when choosing a version number, or writing or reviewing release notes."
---

# Versioning and Changelog

---

## 1. Version

- **Semantic versioning** (`MAJOR.MINOR.PATCH`), judged against the public API in `api.py` (`08-package-files.md`):
  - a breaking change to the public API: MAJOR;
  - a new public name or behavior: MINOR;
  - a bug fix or an internal change: PATCH.
- The version lives only in `pyproject.toml` `[project].version` (`08-package-files.md` section 6). After bumping it, run `mise run inst` so `uv.lock` records it: a bump changes exactly `pyproject.toml` and `uv.lock`.
- The last released version is the latest git tag: `git describe --tags --abbrev=0`.

---

## 2. Changelog: `release-history.rst`

The changelog is `release-history.rst` at the repo root, included by `docs/source/release-history.rst`. It is reStructuredText, not `CHANGELOG.md`, because it renders in the Sphinx docs like every other doc.

```rst
.. _release_history:

Release and Version History
==============================================================================


x.y.z (Backlog)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Features and Improvements**

**Minor Improvements**

**Bugfixes**

**Miscellaneous**


1.2.0 (2026-10-14)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Features and Improvements**

- Add ``ClassName.method_name()`` to do one new thing.

**Bugfixes**

- Fix ``func_name()`` ignoring the ``encoding`` argument on Windows.
```

- **`x.y.z (Backlog)` is the maintainer's planning area.** An AI never edits it, and never copies or moves its content.
- **New versions go directly below the Backlog block,** newest first, as `VERSION (YYYY-MM-DD)` with a 78-character `~` underline.
- **Category order:** **Breaking Changes**, **Features and Improvements**, **Minor Improvements**, **Bugfixes**, **Miscellaneous**. Omit empty categories.
- **Entries are user-facing** (what changed and why it matters), and based on git history, not guesses.
- **Entries are plain text.** Name code with inline literals (``` ``ClassName.method_name()`` ```), never cross-reference roles: the changelog outlives the API, and a role pointing at a removed or renamed name breaks every later build.

**Which category:**

| Change | Category |
| :--- | :--- |
| Removed or renamed public name; raised Python floor (a Python reached end of life); new runtime dependency that users must accept | Breaking Changes |
| New public name or capability | Features and Improvements |
| Better behavior of an existing feature; newly supported Python version; runtime dependency floor raised or cap changed (Breaking Changes instead if users must change their code) | Minor Improvements |
| Fixed wrong behavior | Bugfixes |
| Docs, CI, tooling, dev and test dependency upgrades | Miscellaneous |
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall