Remove planning references and the old `make` aliases
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 83/100
- Issue type
- Refactor
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- build-system
Research direction
Read the Makefile, .github/dependabot.yml, .gitignore, and the Gates section of DEVELOPER.md. Remove the retired aliases and old-name references described in the issue, then run its git grep command to check for planning references in the named files. Done when that search finds no matching lines and the documentation no longer lists the deprecated names.
Written by the indexing model from the issue text.
Description
Description of Technical Debt
The Makefile's header and every deprecation notice cite a planning document that is in no repository, and its
aliases (py-qa, black, pylint, mypy, pytest-unit and their -<alias> forms) were "kept for one release",
which has shipped (v0.1.0). .github/dependabot.yml cites the same document, and .gitignore names a planning
phase. DEVELOPER.md § Gates lists the old names in an "Old name" column. Fifteen lines match today.
Impact of Technical Debt
- Readers chase a document they cannot open; dead aliases stay in the build.
Category
Code Quality / Refactoring
Priority
Low - Nice to have
Proposed Solution
Delete the aliases, the "Old name" column and § Gates' deprecation line, and reword the three comments without a planning reference.
Effort Estimate
1 hour
Dependencies / Related
No response
Additional Context
Measured 2026-11-12 at living-doc-toolkit fea9aa6 (v0.1.0). Re-check:
git grep -n -i -E 'phase[- ]?[0-9]|repo-conventions' -- Makefile .gitignore .github/dependabot.yml
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 19
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from AbsaOSS/living-doc-toolkit
-
tech debt
Difficulty 1/5 Under an hour Newbie friendliness 88/100
AbsaOSS/living-doc-toolkit#120 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 2/5 Half a day Newbie friendliness 84/100
AbsaOSS/living-doc-toolkit#118 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
AbsaOSS/living-doc-toolkit#115 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 4/5 1-2 days Newbie friendliness 55/100
AbsaOSS/living-doc-toolkit#119 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 5/5 Over a week Newbie friendliness 25/100
AbsaOSS/living-doc-toolkit#117 ·
Maintainers usually reply within 1 day
All issues in AbsaOSS/living-doc-toolkit
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
deepchem/deepchem#5289 · 1 comment ·
Maintainers usually reply within 2 days
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 60/100
UKGovernmentBEIS/inspect_evals#2892 · 1 comment ·
Maintainers usually reply within 1 day
-
Versioning docs: say that no output from the 0.46 warning check means nothing is affectedPossibly taken @grelinfo claimed this today. Opendocumentation priority:low size:S
Difficulty 1/5 Under an hour Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
alphacrack/readme2demo#293 ·