8000 docs: issues fixed on unreleased v3 close on merge by adityamukho · Pull Request #585 · project-minigraf/minigraf · GitHub
[go: up one dir, main page]

Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ Current plan (see `ROADMAP.md` and the milestones):
- **v2.x** (`main`, format v7) now gets only data-integrity and security fixes as patch releases (v2.0.3 is the first); v2.0.2 was the last planned v2.x release.
- **v3.0.0** (format v8 and data integrity, tracker #383) is developed on the long-lived `v3` branch. All v3 PRs target `v3`; `main` stays untouched. CI runs on PRs to `v3` the same as on PRs to `main`. Do not merge `main` into `v3` routinely: `main` only gets backports of fixes already on `v3`. Shared CI and workflow changes land on both branches as separate PRs. Just before the v3.0.0 cut, merge `main` into `v3` once (merge commit; source conflicts resolved to `v3`, `main`'s v2.0.x CHANGELOG sections brought over) so the cut is a fast-forward. At the first v3 release, the current `main` is copied to `v2` and `v3` becomes the new `main`.
- **v3.1.0** holds new features (query profiler #185, `:limit` #306/#310, lag/lead #182, UniFFI additions).
- Known v2.x data issue: same-transaction multi-valued facts (#371). Fix ships in v3.0.0. All v2.x known issues are listed in pinned issue #421 (`known-issue` label); `data-integrity`/`corruption`/`durability` issues stay open until the fix is in a published release (CONTRIBUTING.md).
- Known v2.x data issue: same-transaction multi-valued facts (#371). Fix ships in v3.0.0. All v2.x known issues are listed in pinned issue #421 (`known-issue` label); `data-integrity`/`corruption`/`durability` issues fixed in a v2.x patch stay open until that patch is published; issues fixed on the unreleased `v3` branch close on merge (closing keywords do not fire on `v3`, so close them with `gh issue close`) and stay listed in #421 (CONTRIBUTING.md).
- Support policy and tiers: PHILOSOPHY.md §7 and §10. v2.x gets data-integrity and security fixes for 12 months after v3.0.0. Tier 1 = Rust + Python; other bindings are Tier 2.

## Testing Conventions
Expand Down
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,8 @@ Run branch coverage to check overall project health before submitting a PR.

Bugs that can lose, corrupt or hide data are handled so that users can always see them before they adopt a release:

- An issue labelled `data-integrity`, `corruption` or `durability` stays **open until its fix is in a published release**, not just merged. The closing comment links that release. A fix merged only to a development branch (such as `v3`) does not close the issue.
- An issue labelled `data-integrity`, `corruption` or `durability` whose fix ships in a patch to a published line (such as v2.0.x) stays **open until that patch release is published**, not just merged. The closing comment links that release.
- A fix merged to a development branch whose first release has not shipped yet (such as `v3` before v3.0.0) closes its issue on merge: no released version of that line has the bug. If the bug also affects a published release, it keeps its entry in the pinned issue, as below.
- Every such bug that affects a published release also gets the `known-issue` label and an entry in the pinned [Known issues in the current release](https://github.com/project-minigraf/minigraf/issues/421) issue: affected versions, symptom, workaround and fix version. The entry is removed when the fix ships.
- For bugs found downstream, the issue title or body states the affected version range (for example, "v0.6.0 – v2.0.1").
- The README links to the pinned issue from its "Known issues" section.
Expand Down
2 changes: 1 addition & 1 deletion docs/DURABILITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,4 +203,4 @@ A write that returns an I/O error may still have committed (see [Failures while
- **Rules and registered functions are not stored** in the file (#241). Register them after every open.
- **Uncheckpointed transactions are held in memory.** A very large `wal_checkpoint_threshold` grows memory and WAL replay time with the pending transactions. A fact log or cursor left open keeps the transactions that were uncheckpointed when it opened in memory, and the pages later checkpoints replace in the file, until it is dropped; a crash or reopen frees those pages.

Open bugs that affect stored data or recovery carry the [`data-integrity`](https://github.com/project-minigraf/minigraf/issues?q=is%3Aopen+label%3Adata-integrity) and [`durability`](https://github.com/project-minigraf/minigraf/issues?q=is%3Aopen+label%3Adurability) labels; a fix merged for an unreleased version stays open until it ships. Bugs in the current published release, with workarounds and fix versions, are listed in [#421](https://github.com/project-minigraf/minigraf/issues/421).
Open bugs that affect stored data or recovery carry the [`data-integrity`](https://github.com/project-minigraf/minigraf/issues?q=is%3Aopen+label%3Adata-integrity) and [`durability`](https://github.com/project-minigraf/minigraf/issues?q=is%3Aopen+label%3Adurability) labels; a fix for a published line stays open until its patch release ships, while a fix on a branch with no release yet closes when it merges. Bugs in the current published release, with workarounds and fix versions, are listed in [#421](https://github.com/project-minigraf/minigraf/issues/421).
Loading
0