Placeholder System Overhaul (v1.4.0)
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start with the umbrella issue #226 and subtasks #297, #205, #189, #80, #78, and #76 to understand the v1.4.0 scope and acceptance details. Then locate the placeholder and formatting entry points and tests in the repository. Done means the consolidated API, requested placeholders and prefix/postfix controls, default-value fix, tests, and documentation are covered.
Written by the indexing model from the issue text.
Description
Background
The placeholder/formatting engine is the most heavily used subsystem of generate-release-notes, yet it has accumulated fragmented requests across multiple releases. Several individual placeholder features have been requested (#76, #78, #80, #189, #205) alongside a known default-value defect (#297) and a broader architectural proposal (#226) to unify the system.
This epic consolidates all placeholder-related work into a single coherent release, ensuring users get a well-documented, consistent placeholder API after v1.3.0.
Goals
- Fix the known defect where the progress placeholder is absent from the default value configuration (#297)
- Deliver a robust, unified placeholder system and output formatting engine (#226)
- Add all identified missing placeholders (release notes text, contributor template, new placeholders) (#80, #76, #205)
- Give users full control over row-format placeholder prefixes and add prefix/postfix support (#78, #189)
- Ensure all new/changed placeholders are covered by tests and documented
Subtasks
- #297 Progress placeholder is not present in default value
- #226 Feature: Robust Placeholder System and Output Formatting Engine
- #205 Add new placeholder
- #189 Add prefix and postfix to placeholders
- #80 Placeholder(s) for release notes text
- #78 Row format placeholder prefix - add user control
- #76 Add a placeholder for format template for all contributors
Related / References
- Follows v1.3.0 release
- #226 serves as the architectural umbrella for this epic
- Dominant language
- Python
- Stars
- 13
- Forks
- 0
- Avg merge
- 1m
- Merged PRs (30d)
- 4
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/generate-release-notes
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 3/5 1-2 days Newbie friendliness 70/100
-
Difficulty 4/5 3-5 days Newbie friendliness 50/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
epic
Difficulty 5/5 Over a week Newbie friendliness 30/100
All issues in AbsaOSS/generate-release-notes
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 83/100
PedestrianDynamics/pyFDS-Evac#766 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 91/100
alchaincyf/nuwa-skill#86 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 2 days
-
Docs Needs Triage
Difficulty 1/5 Under an hour Newbie friendliness 88/100
pandas-dev/pandas#71055 ·
Maintainers usually reply within 1 day
-
[Bug]: graphify reads files that git's global ignore file hidesPossibly taken @smngvlkz claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Graphify-Labs/graphify#4335 · 1 comment ·
Maintainers usually reply within 1 day