Skip to content

doc: add warning in readme #476

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

Closed
wants to merge 1 commit into from
Closed

doc: add warning in readme #476

wants to merge 1 commit into from

Conversation

riderx
Copy link

@riderx riderx commented Sep 6, 2022

Following this chat, #376
This adds to the README to prevent misleading usage of this package, for people like me who expect SemVer package follow the RCF and specifically this : https://semver.org/#is-v123-a-semantic-version

Following this chat npm#376
This add to the README to prevent misleading usage
@lukekarrys
Copy link
Contributor

I agree there is work to do around explicitly documenting differences from the spec for this package. But this PR doesn't create enough clarity to be merged. I'm going to close this but keep #376 open with the spec label, so when it does get documented that issue can be found.

@lukekarrys lukekarrys closed this Oct 27, 2022
@riderx
Copy link
Author

riderx commented Oct 27, 2022

Thanks for your answer, I understand your point that the PR doesn't add a lot of clarity.
For me that a start, currently, the package is totally not explicit.
Having MVP documentation seems understandable as user.
It will be a first step in the right direction.
Then it will reduce frustration for users and repetitive issue for maintainer.
What do you think?

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

Successfully merging this pull request may close these issues.

2 participants