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

Tweak changelog entry placeholder #8532

Merged
merged 1 commit into from
Sep 28, 2023
Merged

Tweak changelog entry placeholder #8532

merged 1 commit into from
Sep 28, 2023

Conversation

timja
Copy link
Member

@timja timja commented Sep 28, 2023

(head branch, delete on merge)

I'm constantly removing Entry 1: from entries, otherwise they end up in the changelog by accident...
This should hopefully work better?

@timja timja requested review from MarkEWaite and a team September 28, 2023 07:59
@timja timja added the skip-changelog Should not be shown in the changelog label Sep 28, 2023
Copy link
Member

@daniel-beck daniel-beck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the likelihood of the <> remaining? 😁

@timja
Copy link
Member Author

timja commented Sep 28, 2023

What's the likelihood of the <> remaining? 😁

Yeah i'm a little worried about that, if I see it happening I'll remove it in a second iteration.

@timja timja merged commit 8357350 into master Sep 28, 2023
3 of 4 checks passed
@timja timja deleted the timja-patch-1 branch September 28, 2023 08:27
@@ -28,12 +28,15 @@ For refactoring and code cleanup changes, exercise the code before and after the

### Proposed changelog entries

- Entry 1: Issue, human-readable text
- […]
- \<replace with Issue ID if it exists or remove\>, human-readable text
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That pattern got me confused to be honest. I think giving an example would work better.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noting previously negative feedback I got in #7236 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Should not be shown in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants