Skip to content

Commit 762bdb0

Browse files
committed
docs: consolidate coverage governance and release readiness
1 parent 6bd7a84 commit 762bdb0

8 files changed

Lines changed: 1561 additions & 45 deletions

File tree

CHANGELOG.md

Lines changed: 65 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,69 @@
11
# Changelog
22

3-
This file is generated by Release Please based on conventional commit messages.
3+
All notable changes to FlowForge will be documented in this file.
44

5-
Notable releases are also available on the GitHub Releases page.
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
67

8+
## [unreleased] - 2025-10-05
9+
10+
### Documentation
11+
12+
- History cleanup snapshot and procedure (2025-09-17) ([122f68a](122f68a0940a882870030c542056e9251b8e43e7))
13+
- Move sbt-test under docs/archive/sbt-test; remove empty src/ ([d7fda55](d7fda55418050d7647f3ee318f7744d08cd217cd))
14+
- Update plans, quality, and how-it-fails ([7ef826f](7ef826f0fd76982320d7e4d50e86b24622d51cde))
15+
- Cleanup & de-clutter ([4e48127](4e48127147325fd0eafec8d76ec16fb7ab682622))
16+
- Update CHANGELOG.md [skip ci] ([1ee9efe](1ee9efe735ee20c75f96ea3d702b4acfd2b9f07e))
17+
18+
### Miscellaneous Tasks
19+
20+
- Add remaining repository files ([0826710](08267103a383ff16c6dc6f8abed5b3bdab9378c6))
21+
- Docs and tooling updates ([26eaeae](26eaeae69f7bf230921c6c270274313a5f7e6748))
22+
- Ignore unused root dirs (examples, flowforge-docs, benchmarks, integration-tests) ([127a953](127a953a13c5ccb81b05c835350e6ba57d420322))
23+
- Remove empty root src directory ([b86d2ff](b86d2ff7fa55ba3788d0a25f2233c01a684c2245))
24+
- Drop empty root src tree ([1b3db02](1b3db0240a9edb90dd892d95b908bc18c745a298))
25+
- Update ([5ae713b](5ae713b921e157b617156ee735120699ac1035ae))
26+
- Update ([d8cbd6a](d8cbd6a024a8978c829f974bd074aa4b753b3b72))
27+
- Tests bug fixes ([ff4f3b7](ff4f3b77c7a0ec07d849d9d08c66e142b4d59ce4))
28+
- Bug-fixes ([9828f5b](9828f5b521654974579dd8d03608926a47a77d2f))
29+
- Bug-fixes ([0b87616](0b87616ee33e109637905363fda3d84cfeb47760))
30+
31+
### Testing
32+
33+
- Improve coverage ([a84df55](a84df55ca1003ee3b73c54a5bc3336e2f25e439f))
34+
- Improve coverage ([8a89a2e](8a89a2e801c5140d4da6ff17cedf31429481d933))
35+
36+
### Ci
37+
38+
- Improved flows ([3b44251](3b44251819d1ee6c922c65bd7c8f1c3e018aa136))
39+
- Improved flows ([26bd884](26bd884076b7c3719177a8f82504ee673a6d4714))
40+
- Improved flows ([24a5c51](24a5c5108462ee8d45d3a66952c73c8f1ed09e68))
41+
- Improved flows ([026e160](026e16066e4876c4b22a1bbb6eba62015e7786e5))
42+
- Improved flows ([5b80956](5b8095629e055b35945cbc714dabae176c978c6c))
43+
- Improved flows ([90724e9](90724e9883fa013f9c75a30622d9a20f1cc0e821))
44+
- Improved flows ([8f53d2d](8f53d2d4e3521ec3374c82ad5a02055c31a48063))
45+
- Improved flows ([0383bc5](0383bc576f05a34261e1caf3c5fda54fafe9ba68))
46+
- Improved flows ([07d742c](07d742c241cdcefd25f0e4c12d7644f1ba34ea42))
47+
- Improved flows ([b79a899](b79a899375642de4b7c220ed89e42cfc1e097874))
48+
- Improved flows ([ab3a005](ab3a005729eca446bf24d81b059b754987d2e6b5))
49+
50+
### Core
51+
52+
- Preserve nested optionality; add OptionalShape ([13c159d](13c159dee020f6787c4e8bec0f88bb20e97270c6))
53+
- Preserve nested optionality; add OptionalShape ([1e5e5b4](1e5e5b49e6a83cb97d7c8cf94ef0eeaffbc87438))
54+
55+
### Deps
56+
57+
- Bump the gh-actions group with 5 updates ([c1a2e01](c1a2e011334f7217ec760099b5a05a4fbdfad38e))
58+
59+
## [0.9.0] - 2025-09-17
60+
61+
### Documentation
62+
63+
- Examples and giter8 template ([83fe5eb](83fe5ebbc23b0f8d36a06a4c1c272b9467eb8728))
64+
65+
### Testing
66+
67+
- Testing utilities, integration and compile-fail suites ([6f5fca7](6f5fca711086ff9c6ce0c7c272eaa26f9169d302))
68+
69+
<!-- generated by git-cliff -->

docs/INDEX.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@
110110
- **Strategy**: [ADR-014](adr/014-qa-strategy.md)
111111
- **Deequ Integration**: [ADR-005](adr/005-quality-and-deequ-adapter.md), [Evidence](evidence/quality-deequ.md)
112112
- **Error Handling**: [ADR-022](adr/022-safe-generic-error-handling.md)
113-
- **Release Criteria**: [Quality Standards](quality/release-criteria.md)
113+
- **Release Criteria**: [Quality Standards](plan/release-criteria.md)
114114

115115
### Infrastructure & Platform
116116
- **Infrastructure**: [ADR-013](adr/013-infrastructure-layer.md), [Evidence](evidence/infrastructure-layer.md)
@@ -171,7 +171,7 @@ Understanding document authority:
171171
[Bring Your Own Effect](effects/bring-your-own-effect.md)
172172

173173
**Q: Is FlowForge v1.0 ready?**
174-
[v1.0 Readiness](plan/v1.0-readiness.md), [Release Criteria](quality/release-criteria.md)
174+
[v1.0 Readiness](plan/v1.0-readiness.md), [Release Criteria](plan/release-criteria.md)
175175

176176
**Q: How do I contribute?**
177177
[CONTRIBUTING.md](../CONTRIBUTING.md), [Developer Handbook](contributing/HANDBOOK.md)

docs/contributing/HANDBOOK.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,3 +91,6 @@ This bridge indexes the canonical documents while preserving legacy anchors requ
9191

9292
## ADR-002, ADR-011, ADR-012, ADR-013, ADR-014, ADR-018, ADR-019, ADR-020
9393
- See: docs/adr/README.md and docs/adr
94+
95+
## Contributing
96+
- See: docs/contributing/contributors/COVERAGE.md and docs/contributing/contributors/HANDBOOK.md

docs/contributing/contributors/COVERAGE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
> This file maps contributor guidance to current canonical locations.
44
55
## Sources
6-
- Canonical: handbook `docs/contributing/HANDBOOK.md`, ADRs under `docs/adr/*`.
6+
- Canonical: handbook `docs/contributing/HANDBOOK.md`, `docs/contributing/contributors/HANDBOOK.md` ADRs under `docs/adr/*`.
77

88
## Crosswalk (Selected Headings → Canonical)
99
- Teaser / Brutal truth / Targets vs Today → Handbook §1; ADR‑018; ADR‑016

0 commit comments

Comments
 (0)