sanitizers / sanitizers/chronographer-github-app

[TODO] Improve towncrier check to support postfix number and extra suffices

Open
#4 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug enhancement good first issue help wanted
Dominant language
Python
Stars
11
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Valid fragment examples:

  • docs/changelog/smth-else.deprecation (non-strict, not bound to an issue or a PR)
  • docs/changelog/1355.misc (bound to an issue, it's implicit number is 0)
  • docs/changelog/1355.bugfix.rst (bound to an issue, it's implicit number is 0, has a postfix and a suffix)
  • docs/changelog/1355.bugfix.1.rst (bound to an issue, it's explicit number is 1, has a postfix and a suffix)
  • docs/changelog/1355.feature.0.rst (bound to an issue, it's explicit number is 0, has a postfix and a suffix)
  • docs/changelog/1355.feature.1.rst (bound to an issue, it's explicit number is 1, has a postfix and a suffix)

Contributor guide

No contributing guide indexed for this repository

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 linked tox-dev and towncrier discussions to understand the requested fragment syntax, then locate the repository's towncrier-check validation entry point. Use the listed valid examples to guide coverage for implicit or explicit postfix numbers and extra suffixes; done means all examples are accepted without regressing non-strict fragments.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
release, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.