${common-library}

This is a template project for developing common library.

After creating a project using this template don't forget to update this README.md, package.json, CONTRIBUTING.md and CHANGELOG.md files according to your project

Installing

$ npm i @juvare/${common-library}

Note for Windows users:

1. Build scripts, version increment scripts won't work on Windows, use Git Bash to run those.
2. Linting is checking line endings, .gitattributes file should take care of that. If not, you can also try git config --global core.autocrlf false (probably that will need cloning from scratch).

Versioning

This project adheres to Semantic Versioning.
We publish NPM modules to our GitLab server: https://gitlab.juvare.com/common/npm-registry/-/packages

Development Workflow

Implementing Features or Fixing Defects

1. Create a feature/* or bugfix/* branch from main.
2. Write the code.
3. Determine which version number to increment: MAJOR, MINOR or PATCH.
4. Increment the version number by running a command (see "Incrementing Version Numbers").
5. Create a pull request from your branch to main branch.
6. Review and merge the pull request.
7. CI/CD automatically builds and publishes the library.

Incrementing Version Numbers

Always use these commands to increment version numbers.

| Version | Command to Run | | ------- | --------------------------- | | MAJOR | npx library version major | | MINOR | npx library version minor | | PATCH | npx library version patch |