aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorwilliam341 <[email protected]>2017-05-28 12:37:00 -0700
committerGitHub <[email protected]>2017-05-28 12:37:00 -0700
commit771c20cfb3a703e0f1550fdcf9eb07b78298c944 (patch)
tree59cb532e15ebff313fdba2be264d78ec0033f407 /CONTRIBUTING.md
parent496b0cbf8659c99203f48210fd39c572400ae623 (diff)
parentc7ba7d733c756d196f98dd4533289a1ef4db715f (diff)
downloadshiftos_thereturn-771c20cfb3a703e0f1550fdcf9eb07b78298c944.tar.gz
shiftos_thereturn-771c20cfb3a703e0f1550fdcf9eb07b78298c944.tar.bz2
shiftos_thereturn-771c20cfb3a703e0f1550fdcf9eb07b78298c944.zip
Merge pull request #1 from shiftos-game/master
welp, no longer a dev.
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