From f48feb9d385bd20218c46d61d985479a6e8aa915 Mon Sep 17 00:00:00 2001 From: prayagv <76861333+prayagv@users.noreply.github.com> Date: Sat, 11 Jul 2026 11:38:28 +0530 Subject: [PATCH 1/3] docs: soften unqualified maintainability claim in ADR-001 Replace 'production-grade' with a concrete, verifiable rationale for choosing TypeScript over JavaScript. --- docs/adr/001-language-typescript.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adr/001-language-typescript.md b/docs/adr/001-language-typescript.md index 00d498f..b1b9be7 100644 --- a/docs/adr/001-language-typescript.md +++ b/docs/adr/001-language-typescript.md @@ -29,4 +29,4 @@ The project requires a build step before k6 execution. Contributors must maintai | Option | Pros | Cons | Rejected Because | | ---------- | ----------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | | JavaScript | Native k6 authoring, no compile step | Weaker contracts, fewer guardrails, less portfolio signal | Does not meet the strict typing and maintainability goals | -| TypeScript | Strong types, IDE support, zero runtime cost after bundling | Requires build tooling | Best fit for production-grade maintainability | +| TypeScript | Strong types, IDE support, zero runtime cost after bundling | Requires build tooling | Best fit for long-term maintainability and review clarity | From 4a79acfe14d33301da166d0080b28b7ad7d8b6f9 Mon Sep 17 00:00:00 2001 From: prayagv <76861333+prayagv@users.noreply.github.com> Date: Sat, 11 Jul 2026 11:41:39 +0530 Subject: [PATCH 2/3] ci: add documentation claim-language and link check Add a lightweight workflow that rejects workstation-only markdown links and unqualified superlatives, matching the check already used elsewhere in the organization. --- .github/workflows/docs.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..bbc2dfa --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,25 @@ +name: Documentation checks + +on: + pull_request: + paths: + - '**/*.md' + push: + branches: [main] + paths: + - '**/*.md' + +permissions: + contents: read + +jobs: + links-and-claims: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6 + - name: Reject workstation-only links and unsupported superlatives + shell: bash + run: | + set -euo pipefail + ! grep -RInE 'file:///' --include='*.md' . + ! grep -RInE 'production-grade|enterprise-grade|expert-level|staff-level|bulletproof' --include='*.md' . From a20049839758414efdc5605e99cfef6f8ff4de33 Mon Sep 17 00:00:00 2001 From: prayagv <76861333+prayagv@users.noreply.github.com> Date: Sat, 11 Jul 2026 11:53:21 +0530 Subject: [PATCH 3/3] docs: point CI complexity questions at the workflow map Add a pointer to docs/ci-map.md next to the CI and Evidence section so a reviewer questioning the size of the workflow set has an immediate answer for what each one is for. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 75a70d0..d660d6e 100644 --- a/README.md +++ b/README.md @@ -171,6 +171,9 @@ that pool, avoiding a single-account bottleneck. Full non-local workloads also r - Security CI runs npm audit, creates a CycloneDX SBOM, and scans the lockfile with OSV. - [Published performance reports](https://qa-test-automation-frameworks.github.io/k6-performance-framework/) +This is the most CI-heavy repository in the portfolio; see the [CI workflow map](docs/ci-map.md) +for what each workflow is for and why it exists as a separate gate. + ## Documentation - [Architecture](docs/architecture.md)