Skip to content

docs: Implementation flow, CODEOWNERS #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
khvn26 merged 4 commits into from
Oct 28, 2026
Merged

docs: Implementation flow, CODEOWNERS #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6cc0edc
feat: Document spec flow
khvn26 Oct 28, 2026
7c74089
clarify responsibility
khvn26 Oct 28, 2026
c6f0741
docs: Point agents to the README, and add code owners
khvn26 Oct 28, 2026
5753e33
docs: Make the back-end and front-end teams code owners
khvn26 Oct 28, 2026
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
1 change: 1 addition & 0 deletions .github/CODEOWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @Flagsmith/flagsmith-back-end @Flagsmith/flagsmith-front-end
1 change: 1 addition & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Read @README.md
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Read @AGENTS.md
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,6 @@ SDKs implement. The runner creates the scenario's SDK client just before its fir
The spec is released as semver tags (`vX.Y.Z`). SDKs pin a tag, so spec changes never break an SDK
until it opts in.

- **Major** — changed behaviour, reworded `When` steps, or a changed harness protocol.
- **Minor** — new scenarios, tags or `When` steps.
- **Patch** — wording and runner fixes.

Each release also pins the Flagsmith version in `compose.yml` that it was verified against.

## Onboarding an SDK
Expand Down Expand Up @@ -158,3 +154,16 @@ uv run pytest -v

`SDK_COMMAND` can be any command, so you can also run a harness straight against an SDK checkout,
without Docker, e.g. `python ../harness/python/harness.py ../../flagsmith-python-client/sdk-spec/steps.py`.

## Implementing a new spec version

A spec version is implemented in three phases:

1. Spec update. A pull request to this repository is merged, and the new spec version is tagged by a maintainer (see [Versioning](#versioning)).
2. Spec implementation. Renovate proposes the new version to every SDK onboarded in the
[compatibility matrix](.github/workflows/compatibility.yml), as a bump pull request in the SDK's
repository. A bump whose CI is red is fixed by implementing the spec in it. Fixed bumps are
reviewed by the SDK's code owners and merged.
3. SDK releases. Maintainers release each SDK version that includes its merged bump.

A spec version is implemented once every onboarded SDK has released the new spec version.
Loading