Merge pull request #68 from LDAR-Sim/Git-Commit-Template

feat: Add Git commit template

LDAR_Sim/install/.gitmessage

@@ -0,0 +1,21 @@
+<type>: Short summary of change (limit 50 chars)
+# Valid types are :
+# feat - feature
+# fix - bug fixes
+# docs - changes to the documentation like README
+# style - style or formatting change
+# perf - improves code performance
+# test - test a feature
+# data - adding example data
+
+Reason for change: 
+# Describe the problem the change is attempting to solve.
+
+Resolution:
+# Describe how the change solves the problem.
+
+Effect(s) of change:
+# Describe how the resolution may affect existing functionality/code.
+
+# Include Co-authors if any
+#  Format: Co-authored-by: name <[email protected]>

LDAR_Sim/install/SetupIntructions.md

@@ -0,0 +1,72 @@
+# Setup Instructions
+
+## Setting up the LDAR-Sim dev environment
+
+The following were steps taken to create a Ldar_sim virtual environment with conda.
+
+- Install Miniconda3 newest version
+
+From Conda Shell:
+
+- cd into LDAR-Sim/install
+- Run The following commands:
+
+    ```cmd
+    conda config --add channels conda-forge
+    ```
+
+    ```cmd
+    conda config --set channel_priority strict
+    ```
+
+    ```cmd
+    conda create -n ldar_sim --file requirements.txt
+    ```
+
+    ```cmd
+    conda activate ldar_sim_env
+    ```
+
+if you are using satellite modules orbit predictor needs to be added to environement
+
+Run the following command:
+
+```cmd
+pip install orbit_predictor == 1.14.2
+```
+
+## Setting up LDAR-Sim commit templates
+
+Run the following command to set the git commit template into the LDAR-Sim standard:
+
+```cmd
+git config commit.template LDAR_Sim/install/.gitmessage
+```
+
+### Git commit message template
+
+This is what the commit message template should look like
+
+```Diff
+<type>: Short summary of change (limit 50 chars)
+# Valid types are :
+# feat - feature
+# fix - bug fixes
+# docs - changes to the documentation like README
+# style - style or formatting change
+# perf - improves code performance
+# test - test a feature
+# data - adding example data
+
+Reason for change: 
+# Describe the problem the change is attempting to solve.
+
+Resolution:
+# Describe how the change solves the problem.
+
+Effect(s) of change:
+# Describe how the resolution may affect existing functionality/code.
+
+# Include Co-authors if any
+#  Format: Co-authored-by: name <[email protected]>
+```