-
Notifications
You must be signed in to change notification settings - Fork 0
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
Could the title
rule be loosened or ignored ?
#18
Comments
There is no such option, and I'm hesistant to add one. There should be one CHANGELOG.md per repository/project, which makes it obvious for which project it is. |
Well, it would be a shame not to be able to use this checker, just because the title doesn't comply. Having an option (as described in option 1) to ignore individual rules if so desired by the project would help in that regards. |
Being flexible about rules is not a goal here. This is a tool to enforce a style guide. |
I understand and appreciate that, believe me when I say that I really like what you've done here. But it makes adoption a lot harder if people can't incrementally improve something, so having some flexibility is IMO a good thing. |
I don't yet see why this would be an improvement. Can you explain your use case? Do you have e.g. multiple changelogs per repository? Or are the changelogs grouped together in another location (e.g. some website that isn't GitHub, where you're listing multiple changelogs)? |
Just as an example: think a mono-repo where each package in the repo has its own changelog. |
Given a changelog with the following title:
# Changelog for Project ABC
I'm receiving the following warning:
Question
I'd like to keep the title as it is as it is more descriptive than just "Changelog" and clearly links the changelog to the project it belongs with.
Unfortunately I haven't been able to figure out how to do this.
title
warning ?I tried setting
title
tofalse
, but that didn't work:H1
title starts with "Changelog" instead of is "Changelog" ?Note: I'm not very experienced with Node/Node configs, so it may well be that I'm just doing something wrong.
I would just really like to add this check to various (non-JS) projects as I find it important that Changelogs are consistent and comply with Keep A Changelog. (so thank you for making this ruleset!)
The text was updated successfully, but these errors were encountered: