-
Notifications
You must be signed in to change notification settings - Fork 136
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
chore: Sunset towncrier release notes #976
Conversation
805ee6c
to
145abea
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚢
.github/PULL_REQUEST_TEMPLATE.md
Outdated
@@ -5,4 +5,4 @@ | |||
### To-Do | |||
|
|||
[//]: # (Stay ahead of things, add list items here!) | |||
- [ ] Clean up commit history | |||
- [ ] Clean up commit history and use conventional commits |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just closed #953 since it requires a 3rd-party orb, usage of which is not authorized (and will not be) on our circleci account. But I do think adding a lint step to our ci build which validates this is better than simply stating that commits should be "conventional" (tracked in #979). Either way, it's not a blocker for this pr and this is great for the time being.
One thing I would change here is to just make this a hyperlink to "https://www.conventionalcommits.org/en/v1.0.0/" for easy reference
@@ -18,16 +18,22 @@ written. Once things are complete, you can `git reset master` to unstage all | |||
of the changes you've made, and then re-commit them in small chunks using `git | |||
add -p`. | |||
|
|||
## Commit Messages | |||
### Commit Messages |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice catch that our docs were getting out of date here!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💯
145abea
to
5202d69
Compare
What was wrong?
Towncrier is not used anymore for generating release notes. We switched to conventional commits and GitHub releases.
How was it fixed?
newsfragment
folderdocs
folderTo-Do