changelog

authts · Oct 25, 2024 · 6a70b75 · 6a70b75
1 parent d474071
commit 6a70b75
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 1.0.0 (2024-10-25)
+
+- Init `CHANGELOG.md`
diff --git 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). `<semver>` should be one of: `major` | `minor` | `patch`
+
+        npm --no-git-tag-version version <semver>
+
+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
diff --git a/package.json b/package.json
@@ -1,4 +1,5 @@
 {
+  "version": "1.0.0",
   "scripts": {
     "toc": "markdown-toc -i README.md"
   },