@vingy/nimver 4.0.0 → 5.0.0

package/README.md

@@ -34,6 +34,12 @@ nimver install-hooks
 `init` creates `.nimver/config.ini`, pre-populated with sensible defaults.
 `install-hooks` writes a `commit-msg` hook into `.git/hooks/` that delegates to this binary, rejecting messages a release would not be able to read. `.nimver/` should be committed to Git.
 
+The config is checked before it is used: an unknown section or setting, a
+setting written above any section, or a line that does not parse is an error
+naming what it found and the nearest thing it knows. A misspelled
+`[packages.web]` would otherwise leave a workspace with no packages, which reads
+exactly like a repository that never declared any.
+
 ## Everyday use
 
 Just commit normally, using [Conventional Commits syntax](https://www.conventionalcommits.org/):
@@ -88,6 +94,7 @@ sourceFiles = "src/cli/src/**"
 
 `sourceFiles` is optional per package, see [Change attribution](#change-attribution).
 
+
 ### Strategy
 
 The strategy controls how versioning is handled for the packages. There are two strategies: `independent` and `fixed`.
@@ -114,7 +121,8 @@ A changelog lives next to its manifest, so where you put manifests decides how m
   written beside the manifest, with plain `## [1.2.0]` headings.
 - **Several manifests in the same directory** (including the repository root) —
   those packages share the one `CHANGELOG.md` in that directory, and each
-  section names its package: `## [web 1.2.0]`.
+  section names its package: `## [web 1.2.0]`, or `## [@acme/widgets 1.2.0]`
+  for a scoped one.
 
 ### Change attribution
 
@@ -147,7 +155,7 @@ A breaking change will always be treated as a major bump.
 
 Each commit is read under the configuration *it* was made with, taken from its own tree — so changing a mapping today does not rewrite what last week's commits meant, and a package added mid-cycle cannot claim changes made before it existed.
 
-Any commit type not listed here is rejected by the `commit-msg` hook. Add your own types (and adjust bump levels) as needed.
+Any commit type not listed here is rejected by the `commit-msg` hook (this behavior can be adjusted, see [Allowing unknown types](#allowing-unknown-types) for details). Add your own types (and adjust bump levels) as needed.
 
 The default types are:
 
@@ -168,6 +176,26 @@ version = ignore
 wip = ignore
 ```
 
+### Allowing unknown types
+
+By default any type not listed under `[types]` is refused by the `commit-msg` hook,
+and skipped with a warning when a release reads the history back. You can instead allow unknown types to be treated as any of the standard types.
+
+```ini
+[commits]
+unknownType = patch   ; or reject (the default) | ignore | none | minor | major
+```
+
+### Release notes
+
+By default, the commit messages subject is used for the changelog, but a `Release-Note:` footer can override it.
+
+```
+fix(parser): tighten the scope regex
+
+Release-Note: Scopes may now contain digits, slashes and dots.
+```
+
 ## CLI reference
 
 ```