Skip to content

Recommend changelog section order by urgency #706

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

Open
abatko wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Recommend changelog section order by urgency #706

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 20 additions & 12 deletions source/en/1.1.0/index.html.haml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,25 +70,34 @@ version: 1.1.0
%a.anchor{ href: "#types", aria_hidden: "true" }
%h4#types Types of changes

%p
Each type of change below is a section heading under a version. List sections in
the following order of urgency (omit empty sections):

%ul
%li
%code Added
for new features.
%code Security
for fixes to known security vulnerabilities and advisories.
%li
%code Removed
for now removed features.
%li
%code Changed
for changes in existing functionality.
for changes in existing functionality; prefix breaking changes so they stand out
(e.g.
%code BREAKING:
or
%strong BREAKING:
).
%li
%code Deprecated
for soon-to-be removed features.
%li
%code Removed
for now removed features.
%li
%code Fixed
for any bug fixes.
for any bug fixes unrelated to security.
%li
%code Security
in case of vulnerabilities.
%code Added
for new features.

.effort

Expand Down Expand Up @@ -146,9 +155,8 @@ version: 1.1.0
become removals.

%p
If you do nothing else, list deprecations, removals, and any
breaking changes in your changelog.

That said, if you do nothing else, list removals and breaking changes
in your changelog.

%h4#confusing-dates
%a.anchor{ href: "#confusing-dates", aria_hidden: "true" }
Expand Down