From 63fd50bdbfed52de4be4332601944e058b11d793 Mon Sep 17 00:00:00 2001
From: Ayushman Chhabra <14110965+ayushmanchhabra@users.noreply.github.com>
Date: Thu, 1 Feb 2024 12:51:34 -0500
Subject: [PATCH] chore(docs): update readme and changelog

---
 CHANGELOG.md | 4 +++-
 README.md    | 7 ++++++-
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 25c7df24e..81b765757 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -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)
 
diff --git a/README.md b/README.md
index 1aa86ce0c..5216b45a4 100644
--- a/README.md
+++ b/README.md
@@ -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
@@ -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