diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..781b5b4 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 (2024-10-25) + +- Init `CHANGELOG.md` diff --git a/README.md b/README.md index d38d8c7..4300dbc 100644 --- a/README.md +++ b/README.md @@ -313,3 +313,15 @@ Places where this project has been shared. ## History This repo originally lived at [zach-betz-hln/mre-keycloak-react](https://github.com/zach-betz-hln/mre-keycloak-react). For context, see this [issue](https://github.com/authts/react-oidc-context/issues/1208). + +## Contributing + +1. Create a branch from `main`, or a fork of this repo +1. Make your changes +1. Run through the _Setup_ steps in this doc from scratch and confirm everything works +1. Increment the [semantic version](https://docs.npmjs.com/about-semantic-versioning). `` should be one of: `major` | `minor` | `patch` + + npm --no-git-tag-version version + +1. Update `CHANGELOG.md` with a new section +1. PR your changes to be reviewed and merged diff --git a/package-lock.json b/package-lock.json index 258dd78..b43cc5c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,10 +1,12 @@ { "name": "sample-keycloak-react-oidc-context", + "version": "1.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "sample-keycloak-react-oidc-context", + "version": "1.0.0", "devDependencies": { "markdown-toc": "^1.2.0" } diff --git a/package.json b/package.json index 7afbe6e..4da2749 100644 --- a/package.json +++ b/package.json @@ -1,4 +1,5 @@ { + "version": "1.0.0", "scripts": { "toc": "markdown-toc -i README.md" },