python-trio / python-trio/trio
Make it easier to check the formatting of a newsfragment locally
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.3k
- Forks
- 431
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 6
Description
Currently if you want to check the validity of any newsfragment locally you need to do something like
export READTHEDOCS=1
cd docs
make html
but then towncrier will attempt to remove your newsfragments as well as update changelog.rst, which means you need to afterwards restore/unstage the changes to those files.
It would be great to have an invocation of a shell script/tox/hatch/make target/etc that checked the formatting of the fragments without messing up local files.
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 by inspecting the docs build invocation around cd docs and make html, then trace how towncrier processes newsfragments and updates changelog.rst. Add a local check-only entry point and verify that checking formatting leaves the fragments and changelog unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, release
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100