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

Error in the README.md #160

Open
ltspicer opened this issue Mar 10, 2024 · 6 comments
Open

Error in the README.md #160

ltspicer opened this issue Mar 10, 2024 · 6 comments

Comments

@ltspicer
Copy link

ltspicer commented Mar 10, 2024

Error in the README.md.
It should read:
''### WORK IN PROGRESS
and not
''## WORK IN PROGRESS

@klein0r
Copy link
Contributor

klein0r commented Apr 4, 2024

Please wrap your examples in code tags (to prevent markdown parsing)

@AlCalzone
Copy link
Owner

AlCalzone commented Apr 4, 2024

I assume this is related to #159.
As I explained there, I think the readme is correct as it is now. If not, please explain where it is wrong and why.

@klein0r
Copy link
Contributor

klein0r commented Apr 7, 2024

@ltspicer I don't see the issue? Readme is correct

release-script/README.md

Lines 37 to 57 in 111e796

3. Add a placeholder to `README.md` (for your own convenience)
```md
## Changelog
<!--
Placeholder for the next version (at the beginning of the line):
### **WORK IN PROGRESS**
-->
```
or `CHANGELOG.md` if you prefer to have a separate changelog (notice that there is one less `#`):
```md
# Changelog
<!--
Placeholder for the next version (at the beginning of the line):
## **WORK IN PROGRESS**
-->
```

@ltspicer
Copy link
Author

ltspicer commented Apr 7, 2024

Under "usage" one # is too few.

...
...

Usage

In order to use this script, you need to maintain the changelog in either README.md or CHANGELOG.md, because every release must have a changelog. To let the script know which changes are new, use the placeholder:

Changelog

<.!--
Placeholder for the next version (at the beginning of the line):
## WORK IN PROGRESS
-->

@klein0r
Copy link
Contributor

klein0r commented Apr 8, 2024

Ah, okay that's a bit confusing:

release-script/README.md

Lines 61 to 78 in 111e796

## Usage
In order to use this script, you need to maintain the changelog in either `README.md` or `CHANGELOG.md`, because every release must have a changelog. To let the script know which changes are new, use the placeholder:
```md
# Changelog
<!--
Placeholder for the next version (at the beginning of the line):
## **WORK IN PROGRESS**
-->
## **WORK IN PROGRESS**
- Did some changes
- Did some more changes
## v0.0.1 (2020-01-01)

@AlCalzone
Copy link
Owner

Ok essentially what I wrote in the last paragraph here:
#159 (comment)

If anything, we could add a sentence under usage to mention this again [...]

Not sure if that helps though - there will always someone who won't read that.

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

No branches or pull requests

3 participants