Merge branch 'Oliver-Akins:main' into main

.github/ISSUE_TEMPLATE/bug.yaml

@@ -3,6 +3,14 @@ description: The template for all 3rd party bug reports
 labels:
   - bug
 body:
+  - type: markdown
+    attributes:
+      value: >-
+        # Before You Begin
+
+        Make sure that you have checked the [issues](https://github.com/Oliver-Akins/file-hider/issues)
+        page for any bug reports that are similar to yours, if you've found a
+        similar one, make a comment on that issue with your extra information.
   - type: markdown
     attributes:
       value: '# Version Information'
@@ -60,17 +68,3 @@ body:
         List steps that can reproduce the issue. If this is left blank, issues
         may be deemed lower priority and take longer to fix.
       value: 1. Hide a file/folder
-  - type: markdown
-    attributes:
-      value: |-
-        ---
-
-        # Confirmations
-  - type: checkboxes
-    attributes:
-      label: Have you?
-      options:
-        - label: >-
-            I have checked that there isn't already a bug on the GitHub issue
-            tracker for this issue
-          required: true

.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.

.gitignore

@@ -18,6 +18,7 @@ main.js
 
 # obsidian
 data.json
+obsidian-releases
 
 # Exclude macOS Finder (System Explorer) View States
 .DS_Store

README.md

@@ -35,3 +35,7 @@ and adding the `File Hider: Toggle Visibility` command.
 If you want to report a bug or request a new feature, go to the
 [GitHub Repo](https://github.com/Oliver-Akins/file-hider/issues/new/choose) and
 open an issue.
+
+## Contributing
+If you would like to contribute to the codebase, please make sure to read the
+[contributing guidelines](https://github.com/Oliver-Akins/file-hider/blob/main/.github/contributing.md)