eric/promptkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Align licensing documentation and adopt MIT catalogs

Browse Source
This commit is contained in:
Eric Rakestraw
2026-09-26 21:44:52 +00:00
parent 5843ceef82
commit 6e34fb9de5
18 changed files with 712 additions and 179 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/policy/documentation.md
View File

@@ -1,8 +1,8 @@
# Documentation Policy
**Base Policy Version:** 1.1
**Base Policy Version:** 1.5
**Last Updated:** 2026-09-23
**Last Updated:** 2026-09-26
## Purpose
@@ -79,6 +79,11 @@ mechanisms, not secret values.
| Documentation organization | `docs/policy/documentation.md` | Documentation ownership, audience boundaries, maintenance rules, and document lifecycle. | Library architecture or runtime behavior. |
| Testing policy | `docs/policy/testing.md` | Test philosophy, risk-based sufficiency, test boundaries, doubles, coverage guidance, regression policy, and test maintenance. | Subsystem behavior, exact public contracts, subsystem-specific test inventories, and implementation plans. |
| Release policy | `docs/policy/release.md` | Versioning, compatibility, release-note requirements, validation obligations, immutability, recovery, and adoption scope. | Executable commands, publication mechanics, and historical release summaries. |
| Licensing and attribution policy | `docs/policy/oss.md` | Project licensing conventions, attribution format, text and notice-link rules, discoverability, maintenance, and concrete exceptions. | Component entries, license texts, release commands, and dependency security review. |
| Project grant | `COPYRIGHT` | Project identity, holders and years, SPDX expression, grant, warranty disclaimer, and third-party statement. | Complete license texts and component attribution. |
| Project license texts | `LICENSE` | Complete project license and incorporated companion texts. | General licensing policy and dependency attribution. |
| Upstream attribution | `docs/oss/attribution.md` | Component names, copyright statements, license identification, and license, notice, and source links. | General policy and complete standard texts. |
| Standard dependency license texts | `docs/oss/licenses/` | Complete, verbatim texts shared by attribution entries. | Project-specific notices, attribution prose, and policy interpretation. |
| Release procedure | `docs/release.md` | Maintainer prerequisites, candidate preparation, concrete publication guards and commands, verification, and recovery steps. | Release-policy requirements, public API semantics, and historical summaries. |
| Exact exported Go API | Go declarations and GoDoc, as APIs are implemented | Exported names, signatures, types, values, errors, and exact behavioral contracts. | Task-oriented consumer walkthroughs, implementation details, and future API proposals. |
| Framework file formats | `docs/formats.md` | Prompt-definition and profile YAML fields, schema references, defaults, validation modes, built-in profiles, credentials, and file-to-request precedence. | Exported Go declarations, outbound wire behavior, internal parsing mechanics, and application configuration. |
@@ -133,6 +138,14 @@ Adoption is prospective. Previously published tags and historical notes retain
their original records and are not reformatted or rewritten to satisfy the new
requirements.
### Project Licensing And Attribution
The [OSS policy](oss.md) owns licensing conventions, the attribution House
Format, and README/release navigation. COPYRIGHT owns the project grant;
LICENSE supplies complete texts. Component-specific information belongs in
attribution entries, not parallel README or release-note notice lists. The
release procedure owns concrete footer URLs and publication mechanics.
### Security Topics
This policy owns what documentation and examples may contain. Architecture owns