You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tools/spectral/ipa/CONTRIBUTING.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,12 +74,17 @@ npm run gen-ipa-docs
74
74
75
75
A new version of the IPA package will be released when the version in the package.json is changed. To release a new version:
76
76
77
-
-[ ] Determine whether your update is [major/minor/patch] following [semantic versioning](https://semver.org/)
77
+
-[ ] Ensure your branch is clean and you have no outstanding changes. Release PRs should only contain the updated changelog and edits to the package.json
78
+
-[ ] Determine whether your update is major/minor/patch. We follow [semantic versioning](https://semver.org/) custom to the ruleset where:
79
+
- major (X.0.0) - Changes in behaviour to existing rules, breaking changes
80
+
- minor (0.X.0) - New rules or custom extensions
81
+
- patch (0.0.X) - Backwards-compatible bug fixes
78
82
-[ ] Update the version number in package.json
79
-
-[ ] Run `npm run gen-ipa-changelog` and commit the changes.
80
-
-[ ] Open a PR and ensure the title is conventional and scoped to IPA (ie: `ci(ipa): new version`)
83
+
-[ ] Run `npm run gen-ipa-changelog` and commit the changes. The changelog must be updated alongside a new release.
84
+
-[ ] Open a PR and ensure the title is conventional and scoped to IPA (ie: `ci(ipa): release new version`)
85
+
86
+
When your PR is approved and merged to main, the package will be automatically published to the NPM registry.
81
87
82
-
The changelog must only be updated alongside a version bump. A PR for a version release should not include other changes.
0 commit comments