valkyrjaio / valkyrja-ts / 30889220334

100%

push

github

[Readme] fix: Pin the .github document links to the version branch (#172)

# Description

The `.github` document links point at `master`. `.github` maintains a
`26.x`
branch, and `master` is 62 commits behind it, so these links can serve a
document that no longer matches the conventions this repository follows.

Every other link in this README pins a version: the badges read `26.x`,
and the
license link reads `26.x`. A link into `.github` is the same kind of
link, and it
now reads `26.x` too.

The affected documents are `CONTRIBUTING.md`, `SECURITY.md`, and
`VOCABULARY.md`.

Most of these documents hold the same bytes on both branches today, so a
reader
does not get a wrong convention right now. `COPYRIGHT_HEADER.md` already
differs
between the two branches. The link is the defect, not the content of the
day: a
`master` link serves whatever `master` holds when a reader opens it.

A review of valkyrjaio/valkyrja-starter-app-go#1 raised this. The
`master` form
was defended first, because the Java ports write it that way. That was
wrong.
The Java ports carry the same defect, so matching them propagated the
defect
rather than justifying it. `architecture/README.md`, which already pins
`26.x`,
was the correct model.

The Go ports carry the fix in valkyrjaio/valkyrja-go#5,
valkyrjaio/ci-golangcilint-go#9, valkyrjaio/sindri-go#1, and
valkyrjaio/valkyrja-starter-app-go#1.

## Verification

- Every rewritten URL answers 200 on `26.x`.
- Prettier 3.9.6 reports every Markdown file formatted.

## Types of changes

- [ ] Improvement _(non-breaking change which improves code)_
- [x] Bug fix _(non-breaking change which fixes an issue)_
- [ ] New feature _(non-breaking change which adds functionality)_
- [ ] Deprecation _(breaking change which removes functionality)_
- [ ] Breaking change _(fix or feature that would cause existing
functionality to change)_
- [ ] Documentation improvement

## Changes

- **`README.md`** — the `.github` document links read `blob/26.x/`
... (continued)

1735 of 1735 branches covered (100.0%)

Branch coverage included in aggregate %.

3765 of 3765 relevant lines covered (100.0%)

28.9 hits per line