Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update README.md #159

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

Update README.md #159

wants to merge 1 commit into from

Conversation

ticaki
Copy link

@ticaki ticaki commented Mar 10, 2024

add missing #

@mcm1957
Copy link
Contributor

mcm1957 commented Mar 10, 2024

@AlCalzone
Note
While zhe example must gsve 3 # for README.md it might be correct to havebonly 2 for CHANGELOG.md

Maybe this must be described in more Derail to avoid breaking working with CHANGELOG.nd while correnting README.md.

@AlCalzone
Copy link
Owner

This isn't correct. The changelog entries in README have 3 #, while the ones in CHANGELOG only have 2 #.

The documentation is also very clear about this:
grafik

If anything, we could add a sentence under usage to mention this again:

The following assumes that you keep the changelog in `CHANGELOG.md`. If you keep it in `README.md`, prepend another `#`.

or so...

Copy link
Owner

@AlCalzone AlCalzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see above

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants