Skip to content

Commit 61caa35

Browse files
author
Sophia Marie Terry
committed
Refine package release process
1 parent 4d20230 commit 61caa35

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

tools/spectral/ipa/CONTRIBUTING.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,17 @@ npm run gen-ipa-docs
7474

7575
A new version of the IPA package will be released when the version in the package.json is changed. To release a new version:
7676

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
7882
- [ ] 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.
8187

82-
The changelog must only be updated alongside a version bump. A PR for a version release should not include other changes.
8388
---
8489
## Getting Started with IPA Rule Development
8590

0 commit comments

Comments
 (0)