Add Changelog Guidelines #2352 #2358
Conversation
CONTRIBUTING.md
Outdated
|
|
||
| ###How to write a good description? | ||
|
|
||
| - The description should be precise and short. Please keep it in one sentence (Max. 2). |
There was a problem hiding this comment.
Ruben suggested a while ago to describe the behavior of (for example) a new feature in detail. I like this idea and personally would keep it instead of writing just one sentence :)
There was a problem hiding this comment.
That makes sense from a developer point of view. But as a user, I want a straight to the point description. What I mean is the changelog can give you a quick glance on something. If one wants to understand the details, they can click on the link for the Pull Request/Issue/documentation. That's what I noticed at least from researching changelogs of other projects.
There was a problem hiding this comment.
Personally, as a User I would be happy about tipps regarding the usage of the new feature. Therefore I wouldn't restrict the changelog description to be as short as possible. What do you think about something like this: "The description should be precise and short to provide the user with all neccessary information. If it makes sense, add some precise notes about the usage of the new feature."
There was a problem hiding this comment.
That sounds good! Okay I will change it to that
|
[CodeCharta Analysis] Kudos, SonarCloud Quality Gate passed!
|
|
[CodeCharta Visualization] Kudos, SonarCloud Quality Gate passed!
|
Add Changelog Guidelines
Issue: #2352
Description