CyberSource / CyberSource/cybersource-rest-client-node

Conform to semantic versioning

Open
#128 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
49
Forks
50
Avg merge
18m
Merged PRs (30d)
2

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with package.json and inspect how the current 0.0.X version is defined and updated. Read the linked npm semantic-versioning guidance, then trace any version or publishing workflow referenced by the package metadata. Done means the package follows an agreed semantic-versioning scheme and its metadata supports the intended npm update behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, nodejs
Domain
release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.