Merge pull request #20 from ViTeXFTW/docs/github

Update GitHub documentation

Author: ViTeXFTW

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,8 @@
+# Why
+- Tell why the PR has been made
+
+# Changes
+- What has been changed, as much detail as possible
+
+# Issues
+- What issues are this addressing

.gitignore

@@ -1,7 +1,10 @@
+# Project related files
 TODO.txt
 out
+
+# Node files
 node_modules
-client/server
+
+# Vscode files
 .vscode-test
-.vscode
 **/*.js.ma

.vscode/settings.json

@@ -4,5 +4,12 @@
 	"typescript.preferences.quoteStyle": "single",
 	"editor.codeActionsOnSave": {
 		"source.fixAll.eslint": "explicit"
+	},
+	"[markdown]": {
+		"editor.quickSuggestions": {
+			"other": true,
+			"comments": true,
+			"strings": true
+		}
 	}
 }

CONTRIBUTING

@@ -0,0 +1,58 @@
+First of all, thank you for taking an interest.
+
+# Introduction
+Please take some time to read and understand this file. This will help keep the project clean and transparent for all contributors. It will also make it easier for admins and moderators to merge your code suggestions.
+
+# Forks
+The first part is to create your own fork of the project. You can do this directly from GitHub by pressing the fork button in the top right corner. This will create a copy of the repository on your account. In this repository you can do whatever you want without it affecting the original repository. As long as you adhere to the following rules when branching and creating pull requests (PR).
+
+# Branches
+When creating a new branch please adhere to the following guidelines:
+- The branch should match one of the below
+- The branch "sections" are seperated with "/" (slash)
+- The branch name is lowercase
+
+## Issue fixing branch
+If the branch you are creating fixes an issue please name the branch:  
+`issue/(Issue #)/(GitHub name)`
+
+This signals that the branch is trying to fix a known issue.
+
+## Feature branch
+If you would like to add a new feature that you feel is missing. Please create a feature-request issue on the original repository, this way a issue number gets created. Then create the branch with the name:  
+`feature/(Issue #)/(GitHub name)`
+
+## Examples
+
+**Issue:**  
+`issue/18/vitexftw`
+
+**Feature:**  
+`feature/22/Mads`
+
+# Commit messages
+Commit messages should be consice and descriptive. They should specify what section was changed.  
+Please prefix your commit messeage with one of the following.
+
+| Prefix      | Description                |
+|:------------|:---------------------------|
+| fix:        | Fixes a GitHub issue       |
+| feat:       | Adds new feature           |
+| doc:        | Document code/github       |
+| refactor:   | Rewritten code (no effect) |
+
+### Example
+See commit messeage for this PR [#17](https://github.com/ViTeXFTW/ZeroSyntax-Server/pull/17)  
+"Fix: [BUG] Incorrect error in WeaponSet Weapon property #14"
+
+# Pull Requests (PR)
+For PRs please use the attached [PR Template](./.github/PULL_REQUEST_TEMPLATE/pull_request_template.md)
+
+### Example
+See commit messeage for this PR [#17](https://github.com/ViTeXFTW/ZeroSyntax-Server/pull/17)
+
+# Merges
+Merges are only approved by the admin (ViTeXFTW), and will be done when the PR has been reviewed and tested.
+
+# License
+By contributing you agree that your code will be licensed under the [LICENSE](./LICENSE) file in the root directory of this source tree.

README.md

@@ -44,13 +44,13 @@ The server supports context based code completion. This is done by analyzing the
 
 
 ## Contributing
-For contributing you will need to fork the repository, create your own branch make and test any changes you feel is missing from the project and create a pull request. I will then take a look at the code changes and merge the code if everything is in order.
+See [CONTRIBUTIN](CONTRIBUTING)
 
 ## Licsens
 This projct is under the MIT [LICENSE](LICENSE)
 
 ## Sugestions
-As this is my first open-source project, if you have any ideas or suggestions please write to me on eithre Discord or mail. (Discord might be better)
+As this is my first open-source project, if you have any ideas or suggestions please write to me on either Discord or mail. (Discord might be better)
 
 ## Questions
 Discord: ViTeXFTW#6644