From ee2fd5bbcca0da542062338411056774edf95653 Mon Sep 17 00:00:00 2001
From: Will Hunt <will@half-shot.uk>
Date: Wed, 8 Jun 2022 16:30:46 +0100
Subject: [PATCH] Add contributing file (#134)

* Add contributing file

* Rewrite and point at matrix-appservice-bridge

* Add documentation

* Ensure we install matrix-appservice-bridge when building docs

* Also install for release

* changelog

* add contrib file

* Remove artifact step, it doesn't render so nicely

* Update README.md
---
 .github/workflows/docs-latest.yml  |  8 ++++++++
 .github/workflows/docs-release.yml |  8 ++++++++
 CONTRIBUTING.md                    | 11 +++++++++++
 README.md                          |  2 +-
 changelog.d/134.doc                |  1 +
 docs/SUMMARY.md                    |  3 +++
 docs/contributing.md               |  9 +++++++++
 7 files changed, 41 insertions(+), 1 deletion(-)
 create mode 100644 CONTRIBUTING.md
 create mode 100644 changelog.d/134.doc
 create mode 100644 docs/contributing.md

diff --git a/.github/workflows/docs-latest.yml b/.github/workflows/docs-latest.yml
index 8d4f869c..17e61380 100644
--- a/.github/workflows/docs-latest.yml
+++ b/.github/workflows/docs-latest.yml
@@ -9,6 +9,14 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
+      - name: Use Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      
+      # We want to install matrix-appservice-bridge, which we depend on.
+      - run: yarn --ignore-scripts
+
       - name: Setup mdBook
         uses: peaceiris/actions-mdbook@v1
         with:
diff --git a/.github/workflows/docs-release.yml b/.github/workflows/docs-release.yml
index c183d5fe..c8356fb7 100644
--- a/.github/workflows/docs-release.yml
+++ b/.github/workflows/docs-release.yml
@@ -10,6 +10,14 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
+      - name: Use Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+
+      # We want to install matrix-appservice-bridge, which we depend on.
+      - run: yarn --ignore-scripts
+  
       - name: Get release tag
         run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..986f93d5
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,11 @@
+Hi there! Please read the [CONTRIBUTING.md](https://github.com/matrix-org/matrix-appservice-bridge/blob/develop/CONTRIBUTING.md) guide for all matrix.org bridge
+projects.
+
+## Hookshot Guidelines
+
+ - Hookshot presently uses the `main` branch as the default branch (instead of `develop`).
+ - Since Hookshot caters to a range of services, we have additional tags such as `GitHub`, `GitLab`
+   which help us determine which services are affected by an issue.
+ - In addition to Typescript, Hookshot makes use of [Rust](https://rust-lang.org). You will need to setup Rust in order to build the project. https://rustup.rs/ is a good option for most people.
+ - The official hookshot support/development room is [#hookshot:half-shot.uk](https://matrix.to/#/#hookshot:half-shot.uk)
+
diff --git a/README.md b/README.md
index ec114b07..8c49a064 100644
--- a/README.md
+++ b/README.md
@@ -42,4 +42,4 @@ sensible-browser book/index.html
 
 ## Contact
 
-We have a bridge support room you can drop into at [#hookshot:half-shot.uk](https://matrix.to/#/#hookshot:half-shot.uk), or you can reach me at [@Half-Shot:half-shot.uk](https://matrix.to/#/@Half-Shot:half-shot.uk)
+We have a bridge support room you can drop into at [#hookshot:half-shot.uk](https://matrix.to/#/#hookshot:half-shot.uk).
diff --git a/changelog.d/134.doc b/changelog.d/134.doc
new file mode 100644
index 00000000..0b56ea90
--- /dev/null
+++ b/changelog.d/134.doc
@@ -0,0 +1 @@
+Add CONTRIBUTING.md guide.
\ No newline at end of file
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index d48a2c16..3dc890c0 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -17,6 +17,9 @@
     - [GitLab Project](./usage/room_configuration/gitlab_project.md)
 - [📊 Metrics](./metrics.md)
 
+# 🧑‍💻 Development
+- [Contributing](./contributing.md)
+
 # 🥼 Advanced
 
 - [Provisioning](./advanced/provisioning.md)
diff --git a/docs/contributing.md b/docs/contributing.md
new file mode 100644
index 00000000..40940a29
--- /dev/null
+++ b/docs/contributing.md
@@ -0,0 +1,9 @@
+# Contributing
+
+## Matrix.org Bridges
+
+{{#include ../node_modules/matrix-appservice-bridge/CONTRIBUTING.md}}
+
+## Hookshot
+
+{{#include ../CONTRIBUTING.md}}