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.

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

Check for dots as separation #165

Open
koppor opened this issue Oct 23, 2023 · 5 comments
Open

Check for dots as separation #165

koppor opened this issue Oct 23, 2023 · 5 comments
Labels
enhancement New feature or request

Comments

@koppor
Copy link
Contributor

koppor commented Oct 23, 2023

In case a changelog entry ends with a link, there should be a dot before

Example:

wrong:

We fixed an issue where [...] acquiring a file lock [#10452](https://github.com/JabRef/jabref/issues/10452)

right:

We fixed an issue where [...] acquiring a file lock. [#10452](https://github.com/JabRef/jabref/issues/10452)

Maybe, this rule should be explicitly enabled?

One could also implement it as "consistency" check. Currently, we have it mixed in our CHANGELOG.md -- https://github.com/JabRef/jabref/blob/main/CHANGELOG.md

@koppor
Copy link
Contributor Author

koppor commented Jan 9, 2024

Bump, because I see new contributors not following this rule (e.g., https://github.com/JabRef/jabref/pull/10748/files#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4ed)

@charphi
Copy link
Member

charphi commented Jan 10, 2024

I've just checked the changelog of keep-a-changelog and it mainly uses a dot for each entry.
But it is not always the case and issues links are located before the dot.

@koppor
Copy link
Contributor Author

koppor commented Jan 11, 2024

Some examples:

- v1.1 Russian translation (#410).
- Add basic documentation [#4](https://github.com/nbbrd/heylogs/issues/4)
- The last page of a PDF is now indexed by the full text search. [#10193](https://github.com/JabRef/jabref/issues/10193)
- We added the option to use System Preference for Light/Dark Theme [#8729](https://github.com/JabRef/jabref/issues/8729).
- We changed the order of the lists in the "Citation relations" tab. Cites are now on the left and Cited by on the right [#10752](https://github.com/JabRef/jabref/pull/10752)

Rendered

image


The approach of KeepAChangelog seems to be double braces. ( as outer brace and [ as inner brace (for the link). Would also be OK for me - even though it is (much) more work to type. At least, we would have the dots enforced. (And somehow consistent to computer science, where we demand the reference before the dot 😅)

@koppor
Copy link
Contributor Author

koppor commented Jan 11, 2024

We need OpenRewrite for CHANGELOG.md files 🤣🤣

@charphi
Copy link
Member

charphi commented Mar 27, 2024

Requires #17 and #224

@charphi charphi added the enhancement New feature or request label Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants