Skip to content

Commit

Permalink
chore(docs): update readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
ayushmanchhabra committed Feb 1, 2024
1 parent 4ab7b8d commit 63fd50b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
and this project adheres to [Semantic Versioning](http://semver.org/) using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

Since `v4.6.0`, we have switched to automated releases and this file does not need to be manually updated.

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

Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,12 @@ nwbuild({

### Maintainer guidelines

- Approve pull requests before merging.
- Enforce conventional commits before merging pull requests.
- A commit's first line should be formatted as `<type>[optional scope]: <description>`.
- 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.
- Google's Release Please Action is used to update the changelog, bump the package version and generate GitHub releases.

## Roadmap

### Bugs
Expand All @@ -290,7 +296,6 @@ nwbuild({

### Chores

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

0 comments on commit 63fd50b

Please sign in to comment.