From 822f863133f59e79ec387efd4f29433afb272e27 Mon Sep 17 00:00:00 2001
From: Foster Hangdaan <foster@hangdaan.email>
Date: Fri, 8 Nov 2024 08:16:20 -0500
Subject: [PATCH] Add Developing page

---
 Developing.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++
 _Sidebar.md   |  1 +
 2 files changed, 65 insertions(+)
 create mode 100644 Developing.md

diff --git a/Developing.md b/Developing.md
new file mode 100644
index 0000000..532b65b
--- /dev/null
+++ b/Developing.md
@@ -0,0 +1,64 @@
+# Developing
+
+This page provides information on how to get started with development and
+
+## Development Setup
+
+Ensure that the following is installed:
+
+- [Deno](https://docs.deno.com/runtime/getting_started/installation/)
+- [Git](https://git-scm.com/downloads)
+
+Obtain the code by cloning the repo:
+
+```shell
+git clone https://code.fosterhangdaan.com/foster/lume-plugin-kroki.git
+```
+
+Change to the project directory:
+
+```shell
+cd lume-plugin-kroki
+```
+
+Now you are ready to make and [test](#testing) changes.
+
+## Testing
+
+Proper plugin functionality is checked by running tests. Tests are located in
+the `tests` directory. The directory contains some basic tests, as well as a
+test involving a local, non-running instance of a Lume site.
+
+It is imperative to run the tests when making changes. The `test` task is
+provided as a shortcut for running the tests:
+
+```shell
+deno task test
+```
+
+## Commit Message Convention
+
+Git commit messages should follow
+[Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/).
+
+### Types
+
+Refer to the table below for valid commit types:
+
+| Type         | Description                                                                                            |
+| :----------- | :----------------------------------------------------------------------------------------------------- |
+| **build**    | Changes that affect the build system or external dependencies.                                         |
+| **ci**       | Changes to our CI configuration files and scripts.                                                     |
+| **docs**     | Documentation only changes.                                                                            |
+| **feat**     | A new feature.                                                                                         |
+| **fix**      | A bug fix.                                                                                             |
+| **perf**     | A code change that improves performance.                                                               |
+| **refactor** | A code change that neither fixes a bug nor adds a feature.                                             |
+| **style**    | Changes that do not affect the meaning of the code: white space, formatting, missing semi-colons, etc) |
+| **test**     | Adding missing tests or correcting existing tests.                                                     |
+
+## Submitting Changes
+
+Before submitting changes, run the tests&mdash;as described in
+[Testing](#testing)&mdash; ensuring that they all pass.
+[Submit a patch](/Contributing#submitting-patches) if all tests pass.
diff --git a/_Sidebar.md b/_Sidebar.md
index 0a38883..9347317 100644
--- a/_Sidebar.md
+++ b/_Sidebar.md
@@ -2,5 +2,6 @@
 
 ### Content
 
+- [Developing](./Developing/)
 - [Contributing](./Contributing/)
 - [License](./License/)