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.

Sign up for GitHub

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

Jump to bottom

Document how to use towncrier and make a good changelog message #949

Closed
Tracked by #761
hmpf opened this issue Nov 25, 2024 · 3 comments · Fixed by #1112
Closed
Tracked by #761

Document how to use towncrier and make a good changelog message #949

hmpf opened this issue Nov 25, 2024 · 3 comments · Fixed by #1112
Assignees
@johannaengland
Labels
documentation Improvements or additions to documentation

Comments

@hmpf
Copy link
Contributor

hmpf commented Nov 25, 2024 •
edited by johannaengland
Loading

This basically just means taking the current documentation from the README and moving it into the developer's docs.
@hmpf hmpf mentioned this issue Nov 25, 2024
Open
9 tasks
@hmpf hmpf added the documentation Improvements or additions to documentation label Nov 25, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in HTMXify Argus Nov 25, 2024
@hmpf hmpf changed the title How to use towncrier and make a good changelog message Document how to use towncrier and make a good changelog message Nov 25, 2024
@elfjes
Copy link
Collaborator

elfjes commented Dec 2, 2024

from the readme:

towncrier create -c "Changelog content" 214.added.md

should be

towncrier create -c "Changelog content" +214.added.md

@johannaengland
Copy link
Contributor

from the readme:

towncrier create -c "Changelog content" 214.added.md

should be

towncrier create -c "Changelog content" +214.added.md

No, I don't think so. The plus only needs to be added in case it should not be linked to an issue/PR when creating the changelog.

@elfjes
Copy link
Collaborator

elfjes commented Dec 2, 2024

I see, reading is difficult sometimes 😅

@johannaengland johannaengland moved this from 📋 Backlog to 🔖 Ready in HTMXify Argus Dec 2, 2024
@johannaengland johannaengland mentioned this issue Jan 7, 2025
Merged
@johannaengland johannaengland moved this from 🔖 Ready to 🏗 In progress in HTMXify Argus Jan 7, 2025
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in HTMXify Argus Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@johannaengland johannaengland

Labels
documentation Improvements or additions to documentation
Projects
HTMXify Argus
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Move towncrier part from README to docs johannaengland/Argus
3 participants
@elfjes @hmpf @johannaengland