Skip to content

Commit cfc18a4

Browse files
lgamorimclaude
andauthored
Add README status badges and broaden the phase-milestone rule (#23)
* Add status badges to the README ahead of the 1.0.0 cut Give README readers the at-a-glance signals a library consumer looks for: CI health on master, the documentation site, the published NuGet version of the core package, and the license. The two dynamic nuget.org/GitHub badges resolve once the stable package is published; Downloads and per-package badges are deliberately omitted to keep the row to signals with day-one value. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Broaden phase milestones to collect every PR merged during the phase The rule previously bound only M-number PRs to the phase milestone, which left infra and maintenance PRs unassociated and made the milestone under-report what a phase actually ships. Phase milestones now act as the complete release bucket for the phase, answering "what changed in this phase?" in one view. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Record that release candidates are published to nuget.org as prereleases The rule said the annotated tag records that a candidate is not published, but 1.0.0-rc.1 is live on nuget.org: candidates go out as prerelease packages so real consumers can validate them before GA. Align the rule with the practice. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent 4f81bd2 commit cfc18a4

2 files changed

Lines changed: 12 additions & 4 deletions

File tree

.claude/rules/project/sqlbound.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,16 @@ rule go upstream to `claude-rules` first and are then re-synced.
2929
roadmap assigns it, not at a mechanical bump of the previous minor.
3030
- A release candidate does not close its phase: `PackageVersion` moves to
3131
`X.Y.Z-rc.N`, `CHANGELOG.md` gets its own `## [X.Y.Z-rc.N]` entry, and the
32-
annotated tag records that the candidate is not published to nuget.org.
32+
candidate is published to nuget.org as a prerelease so it can be validated
33+
by real consumers (NuGet offers prereleases only to those who opt in).
3334
Further candidates bump `N`; the clean `X.Y.Z` and its `vX.Y.Z` tag at GA
3435
are what close the phase and its milestone.
3536
- Each phase has one matching GitHub milestone (titled
36-
`Phase N — <Name> (<major>.<minor>.x)`), not one per M-number; every
37-
M-number's PR in that phase is associated with the phase's milestone on
38-
creation, and the milestone is closed when the phase's final PR merges. The
37+
`Phase N — <Name> (<major>.<minor>.x)`), not one per M-number; every PR
38+
merged while the phase is in flight — M-number work and chores alike — is
39+
associated with the phase's milestone on creation (retroactively if one
40+
slips through), so the milestone reads as the complete record of what the
41+
phase ships. The milestone is closed when the phase's final PR merges. The
3942
milestone's description lists each composing M-number with its own
4043
description as a bullet, so the phase-level summary and the per-milestone
4144
detail both stay visible in one place.

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
# SqlBound
66

7+
[![CI](https://img.shields.io/github/actions/workflow/status/lgamorim/sqlbound/ci.yml?branch=master&label=CI)](https://github.com/lgamorim/sqlbound/actions/workflows/ci.yml)
8+
[![Docs](https://img.shields.io/badge/docs-lgamorim.github.io-blue)](https://lgamorim.github.io/sqlbound/)
9+
[![NuGet](https://img.shields.io/nuget/v/SqlBound)](https://www.nuget.org/packages/SqlBound)
10+
[![License](https://img.shields.io/github/license/lgamorim/sqlbound)](LICENSE)
11+
712
SqlBound is a .NET library providing [SQLx](https://github.com/launchbadge/sqlx)-equivalent
813
functionality for C#: SQL queries verified at compile time against a real database schema,
914
reflection-free row materialization via a Roslyn incremental source generator, SQL-file

0 commit comments

Comments
 (0)