From 3f6e7accdb06e5bfcd79fbbe1d7263042df6dea6 Mon Sep 17 00:00:00 2001
From: Dave Stewart <info@davestewart.co.uk>
Date: Sun, 24 Apr 2022 12:07:07 +0100
Subject: [PATCH] Update changelog and add contributing guidelines

---
 CHANGELOG.md    | 10 +++++++++-
 CONTRIBUTING.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 55 insertions(+), 1 deletion(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4b92a8f..ff61a17 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,9 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [5.4.0] - 2022-04-22
+### Added
+- Added support to initialize Alias HQ with a Node require flag (#48) - closes #46
+
+## [5.3.0] - 2021-11-25
+### Added
+- Added support for tsconfig extends (#37) - closes #28, #30
+
 ## [5.2.0] - 2021-10-30
 ### Added
-- Added initial TypeScript type definitions
+- Added initial TypeScript type definitions (#33) - closes #29
 
 ## [5.1.7] - 2021-10-30
 ### Fixed
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..f30cdc4
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,46 @@
+# Contributing guide
+
+## Intro
+
+If you are considering contributing, thanks!
+
+The steps below outline the formats expected to be consistent with the existing commits.
+
+## Process
+
+Before writing any code:
+
+- raise an issue
+- discuss the problem
+
+Once it's been agreed what should be done:
+
+- fork the `main` branch
+- work on your code
+
+To submit your code:
+
+- make a pull request
+- make sure the PR title is in the present tense, ie "Add thing"
+- in the description, either:
+  - tag the issue
+  - use the `Closes #xxx` form to automatically close the issue
+- if the code is complex, explain what you've done and why
+
+## Additional requirements
+
+For all changes:
+
+- update the package.json version using [semantic versioning](https://www.baeldung.com/cs/semantic-versioning) (minor: feature, patch: fix)
+- update the [changelog](https://github.com/davestewart/alias-hq/blob/master/CHANGELOG.md), including:
+  - `[version] - date` in `yyyy-mm-dd`
+  - `type` of change(s) - as many are needed
+  - `description` of change(s) - one per line
+  - `(#nn)` PR id in brackets
+  - `- fixes/closes #nn` issue(s) id after
+
+If you are submitting a new plugin:
+
+- read the [plugins](https://github.com/davestewart/alias-hq/blob/master/docs/api/plugins.md) document
+- make sure to include tests as outlined in the above document
+- update the [integrations](https://github.com/davestewart/alias-hq/blob/master/docs/integrations.md) document with a brief description