From 2a811de5c5da930b62c406d9526a907e4cd38a7c Mon Sep 17 00:00:00 2001
From: Oliver Akins <oliver.akins1999@gmail.com>
Date: Thu, 9 Jun 2022 20:35:47 -0600
Subject: [PATCH] Add a contributing file that has style guidelines

---
 .github/contributing.md | 59 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 .github/contributing.md

diff --git a/.github/contributing.md b/.github/contributing.md
new file mode 100644
index 0000000..3575579
--- /dev/null
+++ b/.github/contributing.md
@@ -0,0 +1,59 @@
+# Contributing Guidelines
+
+## General Overview
+Code can be edited and changed on the `main` branch, any large features or
+
+## Code Style
+<ul>
+  <li>
+    Indents should be done with tabs, one tab character per level of indentation.
+  </li>
+  <li>
+    Functions should only be asynchronous if they need to be.
+  </li>
+  <li>
+    Function names should be <code>camelCase</code>
+  </li>
+  <li>
+    Variable names should be <code>camelCase</code>
+  </li>
+  <li>
+    Constant names should be <code>SCREAMING_SNAKE_CASE</code>, <b>except</b>
+    when used in a <code>for ... of</code> loop.
+  </li>
+  <li>
+    Class names should be <code>CapitalCamelCase</code>
+  </li>
+  <li>
+    Brackets should always be included, even if not needed.
+<br>
+<b>Good</b>:
+<pre><code lang="javascript">if ( /* conditional */ ) {
+  /* ... snip ... */
+};
+</code></pre>
+<b>Bad</b>:
+    <pre><code lang="javascript">if ( /* conditional */ )
+  /* ... snip ... */
+</code></pre>
+  </li>
+  <li>
+    Semicolons should always be included, even if not needed.
+<br>
+<b>Good</b>:
+<pre><code lang="javascript">if ( /* conditional */ ) {
+  console.log(`A statement`);
+};
+</code></pre>
+<b>Bad</b>:
+<pre><code lang="javascript">if ( /* conditional */ ) {
+  console.log(`A statement`)
+}
+</code></pre>
+  </li>
+</ul>
+
+
+## Extras
+If there's anything you think was missed please open a [new discussion](https://github.com/Oliver-Akins/file-hider/discussions/new?category=general)
+on GitHub so it can be discussed.
\ No newline at end of file