UTM Attribution (Algolia domains)
This NPM package aims to unify our capture and storage strategy towards UTMs (Urchin Tracking Module) on all Algolia domains/sub-domains (Website, Blog, Dashboard, Docs, etc.).
How to contribute
- Clone this repository:
git clone git@github.com:algolia/utm-attribution.git
- Create a branch, update the code, and make a commit and a PR to
develop
following SEMVER versioning convention.
Releases
Once you consider that the develop
branch holds enough changes to release a new version, here are the 5 steps to follow:
-
make sure you're releasing the correct version:
- Breaking change, bump the first number (1.2.3 -> 2.0.0) - Major
- New feature, bump the second number (1.2.3 -> 1.3.0) - Minor
- Bug fixing, bump the third number (1.2.3 -> 1.2.4) - Patch
- Unsure? Check SEMVER
-
run
npm version [your_version]
. This will automatically:- checkout
develop
- create a branch named with the version number
- update the version number
- push it to GitHub
- checkout
-
have a look at the auto-generated CHANGELOG.md. Update some information manually if needed, commit and push it
-
create two PRs:
- one to merge
[your_version]
intodevelop
(this will update thepackage.json
version) - the other one to merge
[your_version]
intomain
.
- one to merge
-
run
npm run publish
oryarn publish
to push the new release to npm.