Merge pull request #30 from pfgithub/patch-1

Additional information on contribution and usage of our project

4 files changed, 67 insertions, 5 deletions

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..d995742
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,22 @@
+# Contributing to ShiftOS
+
+## Reporting Bugs
+
+Follow the `Templates/IssueTemplate.md`
+
+## Suggesting Enhancements
+
+Follow the `Templates/IssueTemplate.md`
+
+## Pull Requests
+
+Follow our code style
+
+    PublicVariableNames privateVariableNames CONSTANT_VARIABLE_NAMES
+    PublicMethodNames privateMethodNames
+    ClassNames
+    
+    BracketsOnNewLines()
+    {
+    
+    }
diff --git a/README.md b/README.md
index 2118a38..a54ee24 100644
--- a/README.md
+++ b/README.md
@@ -2,16 +2,20 @@
 [![Discord](https://discordapp.com/api/guilds/234414439330349056/widget.png?style=shield)](https://discord.gg/Kd8BJ93) 
 [![Build status](https://ci.appveyor.com/api/projects/status/ktdv3nt6c3q88g2t?svg=true)](https://ci.appveyor.com/project/ComputeLinux/shiftos)
 
-The official, open-source, C# revamp of ShiftOS by Michael VanOverbeek and the ShiftOS devs.
+The official, open-source, C# revamp of ShiftOS.
 
 ## License
 
-We are licensed under the MIT license. All we ask is that you:
+We are licensed under the MIT license. A simple description is:
 
 1. Don't steal our code and call it yours
-2. If you fork us, please leave any copyright statements and license info at the top of all .cs files. You can use the InsertLicense executable to insert the statement into any code files missing the copyright statement.
+2. If you fork us, leave any copyright statements and license info at the top of all .cs files. You can use the InsertLicense executable to insert the statement into any code files missing the copyright statement.
 
 
-## Using our code for your own front-end project
+### Using our code for your own front-end project
 
-You may use the ShiftOS.Engine, ShiftOS.Objects, and ShiftOS.Server projects to create your own games. Just, please, include our original license and linkback to us in your game. After all, we spend a lot of time working on this!
+You may use the ShiftOS.Engine, ShiftOS.Objects, and ShiftOS.Server projects to create your own games. You must include the original license and link back to this in your game or credits.
+
+## Contributing
+
+See `CONTRIBUTING.md`
diff --git a/Templates/IssueTemplate.md b/Templates/IssueTemplate.md
new file mode 100644
index 0000000..9c62fdb
--- /dev/null
+++ b/Templates/IssueTemplate.md
@@ -0,0 +1,23 @@
+# Issue Template
+
+## What you expected to happen
+
+## What actually happened
+
+## Steps To Reproduce
+
+    # What you expected to happen
+
+    # What actually happened
+
+    # Steps To Reproduce
+    
+# Suggestion Template
+
+## What should be added to the game/api
+
+## Why it should be added
+
+    # What should be added to the game/api
+    
+    # Why it should be added
diff --git a/Templates/PullRequestTemplate.md b/Templates/PullRequestTemplate.md
new file mode 100644
index 0000000..49948c0
--- /dev/null
+++ b/Templates/PullRequestTemplate.md
@@ -0,0 +1,13 @@
+# Pull Request Template
+
+## What did you change
+
+## Benefits
+
+## Drawbacks
+
+    # What did you change
+    
+    # Benefits
+    
+    # Drawbacks