aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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