`SPEC.md` and the review rules ask for a major bump on a breaking change

Open Beginner friendly
  • Is something wrong?
#120 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Read DEVELOPER.md § Versioning, then compare the version impact wording in SPEC.md § 4 and .github/copilot-review-rules.md. Update both places to match the documented 0.x rules for breaking changes and release notes. Check completion with the issue’s suggested git grep command; it is done when no “major bump” match remains in those files.

Written by the indexing model from the issue text.

Description

tech debt
Description of Technical Debt

SPEC.md § 4 Cross-cutting contract changes asks every contract change to state its version impact as "additive (no
bump), or breaking (major bump of the affected package)", and .github/copilot-review-rules.md makes the reviewer
confirm it in the same words. DEVELOPER.md § Versioning and the ecosystem's version rules, in living-doc
CONTRIBUTING.md § Releasing the ecosystem, say otherwise: while the toolkit is 0.x, a breaking change is a minor, a
patch never breaks, and every breaking change is in the release notes with its migration.

Impact of Technical Debt
  • A spec or review that follows these lines asks for 1.0.0 at the next breaking change, a version the ecosystem keeps
    for the day every package freezes its contracts together.
Category

Documentation

Priority

Low - Nice to have

Proposed Solution

Reword the version impact in both places by DEVELOPER.md § Versioning: additive or breaking, and a breaking change is a
minor while the toolkit is 0.x, listed in the release notes with its migration.

Effort Estimate

1 hour

Dependencies / Related

No response

Additional Context

Found when the ecosystem's rules were written down (living-doc #109). Measured 2026-11-12 at living-doc-toolkit
fea9aa6 (v0.1.0): SPEC.md:124, .github/copilot-review-rules.md:50. Re-check:

git grep -n 'major bump' -- SPEC.md .github/copilot-review-rules.md — fixed when nothing matches.

Dominant language
Python
Stars
0
Forks
0
Avg merge
1d 7h
Merged PRs (30d)
19

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AbsaOSS/living-doc-toolkit

All issues in AbsaOSS/living-doc-toolkit

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.