aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMichael VanOverbeek <[email protected]>2017-04-07 17:02:38 +0000
committerMichael VanOverbeek <[email protected]>2017-04-07 17:02:38 +0000
commit3d48f3101aa25050e6b219fc1111293273a59fa4 (patch)
tree40bf8d722245d02d87b0914a38e2b09673e093c0 /CONTRIBUTING.md
parentedf4aef6adf8a2a45c347f70804fc5ac93070576 (diff)
parent3789b48df00e89fa6dcd7e27bb6885ba880504f6 (diff)
downloadshiftos_thereturn-3d48f3101aa25050e6b219fc1111293273a59fa4.tar.gz
shiftos_thereturn-3d48f3101aa25050e6b219fc1111293273a59fa4.tar.bz2
shiftos_thereturn-3d48f3101aa25050e6b219fc1111293273a59fa4.zip
Merge branch 'master' of https://github.com/shiftos-game/ShiftOS
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md39
1 files changed, 31 insertions, 8 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d995742..8dd07d6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,12 +1,30 @@
# Contributing to ShiftOS
-## Reporting Bugs
+## Reporting Bugs / Suggesting Enhancements
-Follow the `Templates/IssueTemplate.md`
+### Issue Template
-## Suggesting Enhancements
+#### What you expected to happen
-Follow the `Templates/IssueTemplate.md`
+#### 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
## Pull Requests
@@ -14,9 +32,14 @@ Follow our code style
PublicVariableNames privateVariableNames CONSTANT_VARIABLE_NAMES
PublicMethodNames privateMethodNames
- ClassNames
-
- BracketsOnNewLines()
+ ClassNamesLikeThis
{
-
+ public Type VariableName;
+
+ public void BracketsOnNewLines()
+ {
+ var variableName;
+ }
}
+
+Insert licenses at the top of ALL `.cs` files