search

sphinx-contrib / sphinxcontrib-towncrier

An RST directive for injecting a Towncrier-generated changelog draft containing fragments for the unreleased (next) project version. Demo: https://ansible-pylibssh.rtfd.io/changelog. Docs: https://sphinxcontrib-towncrier.rtfd.io
https://pypi.org/p/sphinxcontrib-towncrier
BSD 3-Clause "New" or "Revised" License
19 stars 18 forks source link

Rename this repo to towncrier? #87

Closed Freed-Wu closed 1 year ago

Freed-Wu commented 1 year ago

According to https://github.com/sphinx-contrib/github-administration:

rename the repository to remove prefixes like sphinx, sphinx-contrib, and sphinxcontrib. Don't forget to update the documentation in the repository, too!

webknjaz commented 1 year ago

That was the original name and many people (not me!) wanted it prefixed. The reasoning was that it could be confused with the towncrier project IIRC. But also, when people make forks, their forked repo name doesn't preserve the org name, unless they manually edit it. This also leads to similar confusion. While I like this idea a lot, we must respect other people's options 🤷‍♂️.

webknjaz commented 1 year ago

Here, @dhellmann granted us an exception: https://github.com/sphinx-contrib/sphinxcontrib-towncrier/issues/5#issuecomment-668601345

Freed-Wu commented 1 year ago

OK, advise to pin #5 for visibility :smile:

webknjaz commented 1 year ago

I don't think any of the end-users would care about the repo name. In 3 years, nobody asked a question about it. It's too rare for such a pin to the useful, objectively.