[ci skip] Update contributing guide #19732
Conversation
|
Hi @wazery, Thanks for the patch. Actually the fact that new entries should be at the top is already mentioned in the lines under the one you edited. I think @matthewd meant that we should highlight it more. Maybe we should remove the "and it should got on top of a CHANGELOG" part of the sentence and add a whole new line after "you should attach the issue's number" like:
What do you think Matthew ? |
|
Hi @robin850 +1 for a new line and emphasizing the "at the top" part of the sentence. I can amend the commit after Matthew's opinion. |
|
Hmm. I suspect this change would help as written, and we could just remove the now-redundant mention in the second paragraph. I actually looked for an "at the top" here last time I fixed one manually, and didn't see that it was already stated. 😥 |
|
@matthewd I will remove the second mention and emphasize the "at the top" part. |
|
Edited the commit, I hope it can be merged now. |
|
|
||
| A CHANGELOG entry should summarize what was changed and should end with author's name and it should go on top of a CHANGELOG. You can use multiple lines if you need more space and you can attach code examples indented with 4 spaces. If a change is related to a specific issue, you should attach the issue's number. Here is an example CHANGELOG entry: | ||
| A CHANGELOG entry should summarize what was changed and should end with author's name. You can use multiple lines if you need more space and you can attach code examples indented with 4 spaces. If a change is related to a specific issue, you should attach the issue's number. Here is an example CHANGELOG entry: |
There was a problem hiding this comment.
Let's fix this sentence too. There's a "the" missing in front of "author's".
[ci skip] Update contributing guide
|
@wazery Thanks 😉 |
|
@kaspth 😃 |
Just mention the correct place for the new entries to the CHANGELOG.