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

Conform to semantic versioning #128

Open
Caryyon opened this issue Jan 24, 2024 · 0 comments
Open

Conform to semantic versioning #128

Caryyon opened this issue Jan 24, 2024 · 0 comments

Comments

@Caryyon
Copy link

Caryyon commented Jan 24, 2024

The current versioning for the package does not follow common practices for the environment it's being packaged for. Most npm packages follow semantic versioning, which aids both the consuming engineers as well as the distributing engineers.

Currently the versioning has been done all within the "patch" decimal place, example: 0.0.X
This has a few side effects when utilizing npm as your distribution platform, because there are prefixes that can be applied within the package.json that depend on the versioning adhering to semantic versioning. An example of that would be the ^ prefix, example: "cybersource-rest-client-node": "^0.0.30" this would mean that when installing the package npm will take any update to 'minor' or 'patch', in the current context of writing this would be 0.0.52. This feature is there to allow for an easier development experience for the engineers making the package as they can push more regularly, and allows for the consuming engineers to not have to be so diligent about monitoring small updates for all of the imported packages in their projects.

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

No branches or pull requests

1 participant