Skip to content

Commit 63fd50b

Browse files
chore(docs): update readme and changelog
1 parent 4ab7b8d commit 63fd50b

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

CHANGELOG.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
All notable changes to this project will be documented in this file.
44

55
The format is based on [Keep a Changelog](http://keepachangelog.com/)
6-
and this project adheres to [Semantic Versioning](http://semver.org/).
6+
and this project adheres to [Semantic Versioning](http://semver.org/) using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
7+
8+
Since `v4.6.0`, we have switched to automated releases and this file does not need to be manually updated.
79

810
## [4.6.0](https://github.com/nwutils/nw-builder/compare/v4.5.4...v4.6.0) (2024-02-01)
911

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,12 @@ nwbuild({
270270

271271
### Maintainer guidelines
272272

273+
- Approve pull requests before merging.
274+
- Enforce conventional commits before merging pull requests.
275+
- A commit's first line should be formatted as `<type>[optional scope]: <description>`.
276+
- A commit's body should have a description of changes in bullet points followed by any links it references or issues it fixes or closes. It may include an optional `Notes: ...` section to provide additional context on why the PR is being merged when it doesn't seem like it should.
277+
- Google's Release Please Action is used to update the changelog, bump the package version and generate GitHub releases.
278+
273279
## Roadmap
274280

275281
### Bugs
@@ -290,7 +296,6 @@ nwbuild({
290296

291297
### Chores
292298

293-
- chore(cicd): use `google-github-actions/release-please-action` to automate publishing to npm, updating changelog and creating releases
294299
- chore(cli): migrate from `yargs` to `commander`
295300
- chore(get): verify sha checksum for downloads
296301
- chore(util): factor out file paths as constant variables

0 commit comments

Comments
 (0)