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.

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

Jump to bottom

follow Keep a Changelog format #1873

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

follow Keep a Changelog format #1873

wants to merge 2 commits into from

Conversation

R3dst0ne
Copy link
Contributor

Update CHANGES.md to follow the Keep a Changelog format.

@R3dst0ne
follow Keep a Changelog format
670eeea 
Update CHANGES.md to follow the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format.
@R3dst0ne
Copy link
Contributor Author

Currently, the MD Lint is failing because of the duplicate headings (E.g. ### Added).
In order to follow the format, it is necessary to disable this rule for this file.

Sadly, I'm not familiar on how this action works. Could someone do the necessary step's ore guide me through them?

@MarcinOrlowski
Copy link
Member

There's .markdownlint.yaml file that controls the linter. What you however may want to do here is to exclude this particular rule for CHANGES.md file only.

@MarcinOrlowski
Copy link
Member

That reminds me that thing that I always wanted is a GHA that ensures every PR touches CHANGES.md and adds at least line to it. @R3dst0ne can you create it too?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BFH-ktt1 BFH-ktt1 Awaiting requested review from BFH-ktt1 BFH-ktt1 is a code owner

@davidhutchens davidhutchens Awaiting requested review from davidhutchens davidhutchens is a code owner

@maehne maehne Awaiting requested review from maehne maehne is a code owner

@MarcinOrlowski MarcinOrlowski Awaiting requested review from MarcinOrlowski MarcinOrlowski is a code owner

@zdimension zdimension Awaiting requested review from zdimension zdimension is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@R3dst0ne @MarcinOrlowski