Merge pull request #10 from RoboJackets/feat/github_templates

Feat/GitHub templates

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,27 +1,28 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Report a bug in urc-software
 title: ''
 labels: ''
 assignees: ''
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+## Description
+A clear and concise description of what the issue is.
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+## Steps To Reproduce
+1. Step 1
+2. Step 2
 
-**Expected behavior**
+Result: ???
+
+- [ ] This bug has been reproduced by someone else
+
+## Expected behavior
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
+## Screenshots
 If applicable, add screenshots to help explain your problem.
 
-**Additional information**
+## Additional information
 Any information that could be help with debugging. i.e., suspicions on where the issue lies, any debugging work you've done so far, cases that seem to trigger the bug more often than normal, etc.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+# Description
+
+{{ State the context of this PR }}
+
+This PR does the following:
+- Thing 1
+- Thing 2
+- Thing 3
+
+Fixes #{{ github issue }}
+
+## Design Documents
+[Link](link-to-design-doc)
+
+# Testing steps (If relevant)
+## Test Case 1
+1. Do this thing
+2. Do that thing
+3. Make the thing do the thing
+
+Expectation: The thing which does the thing does the thing
+
+# Self Checklist
+- [ ] I have formatted my code using `make format`
+- [ ] I have tested that the new behaviour works 

Makefile

@@ -0,0 +1,7 @@
+# This file is used for aliases for long commands such as clang-format
+files := $(shell find . \( -name '*.h' -or -name '*.hpp' -or -name '*.cpp' \) -not -path "./external/*")
+
+format:
+ifneq ("$(files)","")
+ clang-format -i $(files)
+endif