Sqlitecpp Workflow
Developmentsqlitecpp-workflowSqlitecpp Workflow is an Agent Skill for development published in the SRombauts/SQLiteCpp repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
SQLiteCpp change workflow checklists for API, tests, build files, and CHANGELOG updates. Use when adding a method or class, editing build files, or writing a CHANGELOG entry for a PR.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/SRombauts/SQLiteCpp/blob/HEAD/.claude/skills/sqlitecpp-workflow/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/sqlitecpp-workflow, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
SQLiteCpp Workflow
Change checklist
- Public API has Doxygen (
@brief,@param,@return,@throw). - Tests added under
tests/. - Build files updated (
CMakeLists.txt,meson.build). -
CHANGELOG.mdupdated for user-facing changes.
CHANGELOG conventions
Update CHANGELOG.md in the same PR that makes the change, not in a later batch. Add one line per
PR under the current unreleased version heading (Version X.Y.Z - <year> ???). Create that heading
if it does not exist yet.
- One bullet per PR:
- <description> (#NNN). The PR number is the last token, in parentheses. - Write in the imperative mood, present tense: "Add", "Fix", "Update", "Remove". Not "Added", "Fixes", or "Adding".
- Keep each entry to a single line that names the user-facing effect, not the internal mechanics.
- Put the SQLite version bump first when the release includes one (see [[sqlitecpp-update-sqlite]]).
- Order the rest roughly as features, fixes, build/CI, then docs and tooling.
- A change merged straight to master without a PR still gets a bullet; omit the
(#NNN)and note it was committed directly to master. - ASCII only, no em dashes. Run the entry through the
humanizerskill before committing so the prose stays plain and free of AI tells.
Finalizing the version heading and tagging belong to the release process: see [[sqlitecpp-release]].
Pull requests
- Open PRs with
gh pr createagainstmaster. - The maintainer wants a short and tight PR description: one or two sentences on what the PR
does and why, plus a brief bullet list only when it genuinely helps review. No filler, no
restating the diff, no marketing. ASCII only, no em dashes; run it through
humanizerif unsure.
Add a method
- Declare in
include/SQLiteCpp/<Class>.hwith Doxygen. - Implement in
src/<Class>.cpp. - Add tests in
tests/<Class>_test.cpp. - Update
CHANGELOG.md.
Add a class
- Create
include/SQLiteCpp/NewClass.handsrc/NewClass.cpp. - Add files to
CMakeLists.txt(SQLITECPP_SRCandSQLITECPP_INC). - Add files to
meson.build. - Include in
SQLiteCpp.hif public API. - Create
tests/NewClass_test.cpp. - Add test to
CMakeLists.txtandmeson.build.