OvertureMaps / OvertureMaps/schema
[CHORE] Add a towncrier "deprecation" changelog type
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 213
- Forks
- 22
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 31
Description
Sub-issue of #639 — surface 3 of 3 ("What flows where"), manual path.
Scope
Give deprecations their own changelog section, so a PR that deprecates a field or model ships a <pr>.deprecation.md fragment like any other change.
Independent of every other sub-issue: it touches only the towncrier config and the contributor docs, and needs neither the extraction carrier nor any generated output.
Work
- Add a
[[tool.towncrier.type]]block fordeprecationto the rootpyproject.toml([tool.towncrier]at ~102, existing types at ~109-132). Place it afterbreakingso deprecations lead the notes ahead of features. - Document the type in the changelog quick-start (
docs/versioning.md) alongsidebreaking/feature/bugfix/docs/misc, and in the changelog-fragment guidance inCONTRIBUTING.md.
Acceptance
towncrier buildrenders a<pr>.deprecation.mdfragment under its own heading, in the intended position.- The
Require changelog on package changeCI check acceptsdeprecationas a fragment type.
Follow-on
Automatic fragment generation — a codegen deprecation-manifest target that diffs against the last released tag and writes these fragments itself — is #677. This issue ships regardless of whether that one does.
Contributor 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.
Research direction
Start with the [tool.towncrier] configuration and existing type blocks in pyproject.toml, then read the changelog quick-start in docs/versioning.md and fragment guidance in CONTRIBUTING.md. Add the deprecation type in the requested position and document it consistently. Run towncrier build and verify that a .deprecation.md fragment renders under its own heading and passes the changelog CI check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 82/100