promptkit/docs/development.md

Development

This is the contributor entry point for Promptkit, a reusable Go library. All contributors must read the architecture policy before making changes.

Initial Orientation

Before starting work:

1. inspect the working tree and preserve unrelated changes;
2. read the policy, contract, and internal documents listed for the task;
3. inspect the relevant implementation and tests before deciding how to change them; and
4. keep documentation limited to implemented behavior unless an accepted decision or temporary roadmap explicitly owns future work.

Start with:

• the architecture policy for library boundaries, dependency direction, invariants, and non-goals;
• the internal component overview for the current package and component inventory;
• the documentation policy before changing documentation;
• the testing policy before adding, rewriting, or deleting tests; and
• the release procedure for version and publication work.

Task-Specific Reading Guide

Task	Read before changing
Root public API	The architecture policy, consumer guide, testing policy, and existing GoDoc.
Prompt, profile, or schema formats	The framework format reference, owning parser or validator package, and documentation policy.
Source loading or validation	The framework format reference, internal source document, and owning package tests.
Model-client behavior	The OpenAI-compatible integration contract, internal model-client document, and owning package tests.
Internal package implementation	The architecture policy, internal component overview, and focused internal document listed for that package.
Tests or test fixtures	The testing policy, owning package, and focused internal document listed by the component overview.
Maintained example	The example, consumer guide, framework format reference, and documentation policy.
Documentation	The documentation policy and canonical owner of every affected contract.
Release preparation or publication	The release procedure.

For cross-cutting changes, follow every applicable row. Do not create placeholder documents for packages, APIs, or integrations that do not yet exist.