Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme should describe the intented workflow #86

Open
htgoebel opened this issue Aug 19, 2017 · 2 comments
Open

Readme should describe the intented workflow #86

htgoebel opened this issue Aug 19, 2017 · 2 comments
Labels

Comments

@htgoebel
Copy link

i was suggested to use towncrier as the silver bullet for creating NEWS.rst files. Thus I thought, it will fetch the log messages, magically converts them and creates the NEWS.rst file. Obviously it does not.

As far as I understand, the developer has to create the fragments in the newsfragments directory manually. towncrier "only" sorts them (by which criteriea?) and creates the NEWS.rst file.

This workflow needs to be described in the readme.

@htgoebel htgoebel changed the title Redme should describe the intented workflow Readme should describe the intented workflow Aug 19, 2017
@hawkowl
Copy link
Member

hawkowl commented Aug 21, 2017

Yes, the developer writes the news fragments in the directory (ideally, in more user-focused prose than would exist in the git commit). I'll make a note of this for my docs updates.

@michaeljoseph
Copy link

@htgoebel tagging #89 as fix for this.

@altendky altendky added the docs label Nov 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants