Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 1.79 KB
Raw

Contributing to @axa-fr/oidc-client

First, ensure you have the latest pnpm.

To get started with the repository:

git clone https://github.com/AxaFrance/oidc-client.git

cd oidc-client
pnpm install

# oidc client demo
cd examples/oidc-client-demo
pnpm install
pnpm start
# then navigate to http://localhost:5174

# react vite demo
cd examples/react-oidc-demo
pnpm install
pnpm start
# then navigate to http://localhost:4200

# react NextJS demo
cd examples/nextjs-demo
pnpm install
pnpm run dev
# then navigate to http://localhost:3001

You are now ready to contribute!

Pull Request

Please respect the following PULL_REQUEST_TEMPLATE.md

Packages are automatically published on npm when a PR is merged on main.

Example of commit messages :

To publish a patch version (0.0.x) :

  • fix(oidc): my message (alpha) => will publish next patch as an alpha
  • chore(oidc): my message (beta) => will publish next patch as an beta
  • refactor(oidc): my message (release) => will publish next patch release (with automatic git tag and release)

To publish a minor version (0.x.0) :

  • feat(oidc): my message (alpha) => will publish next minor as an alpha
  • feat(oidc): my message (beta) => will publish next minor as an beta
  • feat(oidc): my message (release) => will publish next minor release (with automatic git tag and release)

To publish a major version (x.0.0) :

  • fix(oidc): my message containing BREACKING word (alpha) => will publish next major as an alpha
  • fix(oidc): my message containing BREACKING word (beta) => will publish next major as an beta
  • fix(oidc): my message containing BREACKING word (release) => will publish next major release (with automatic git tag and release)

Issue

Please respect the following ISSUE_TEMPLATE.md