From fdcf780d314dbbfba15db6a44f907c068ad21755 Mon Sep 17 00:00:00 2001
From: Jake Wiesler <jakewiesler@gmail.com>
Date: Wed, 17 Jun 2020 08:49:47 -0400
Subject: [PATCH] docs: add CONTRIBUTING.md

---
 CONTRIBUTING.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..751b297
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,57 @@
+# Contributing
+
+First off, thank you for your time and effort! This project is not very large and easy to jump into.
+
+## Development stack
+
+- Built with [Hugo](https://gohugo.io/) 🔥
+- [Gulp](https://gulpjs.com/) as a build tool 🍹
+- Styles in [Stylus](http://stylus-lang.com/) 💅🏻
+
+## Getting started
+
+The first thing you'll want to do is clone the repository:
+
+```bash
+# https
+git clone https://github.com/jakewies/hugo-theme-codex.git
+
+# ssh
+git clone git@github.com:jakewies/hugo-theme-codex.git
+```
+
+Next, you'll want to install dependencies with `yarn`:
+
+```bash
+cd hugo-theme-codex
+
+yarn install
+```
+
+There are 3 npm scripts that can be used for development purposes:
+
+```bash
+yarn develop
+```
+
+This command will start a hugo webserver and serve the `exampleSite`. This works well because the example site uses `hugo-theme-codex`, so any changes
+we make to the codebase can be viewed in real time.
+
+```bash
+yarn watch:assets
+```
+
+If you are working with `js` or `css` you will probably want to run this command in a separate tab from `yarn develop` so that any changes to assets like javascript and css will trigger a re-build by `gulp``.
+
+```bash
+yarn build:assets
+```
+
+Triggers a one-time build of the static directory.
+
+## Questions
+
+If you have any questions feel free to reach out to me directly. Best ways to contact me:
+
+- Twitter: https://twitter.com/jakewies
+- Email: jakewiesler@gmail.com