OvertureMaps / OvertureMaps/schema

[CHORE] Add a towncrier "deprecation" changelog type

Open Beginner friendly
#675 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

chore
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 for deprecation to the root pyproject.toml ([tool.towncrier] at ~102, existing types at ~109-132). Place it after breaking so deprecations lead the notes ahead of features.
  • Document the type in the changelog quick-start (docs/versioning.md) alongside breaking / feature / bugfix / docs / misc, and in the changelog-fragment guidance in CONTRIBUTING.md.

Acceptance

  • towncrier build renders a <pr>.deprecation.md fragment under its own heading, in the intended position.
  • The Require changelog on package change CI check accepts deprecation as 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

Open the contributing guide

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.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.