Merge pull request #25 from sergeant-savage/chore/add-contributing-docs

Add CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing
+
+Contributions are welcome and help greatly improve the app.
+
+## Local Run
+
+To get started, you'll need:
+- The Rust toolchain
+- `cargo-shuttle`
+
+To install the Rust toolchain [click here](https://rustup.rs) and follow the appropriate instructions for your operating system.
+To install `cargo-shuttle`, run `cargo install cargo-shuttle`.
+
+Once you have all the prerequisites, to build, simply run `cargo shuttle run`.
+This will compile any necessary dependencies and run the site on [localhost port 8000](http://localhost:8000).
+From there, there is one more step necessary to begin local development.
+You must enter the `main.js` file and change out `wss://` with `ws://`.
+This is because while the hosting service provides a secure connection, localhost does not.
+Once you have done this you will be able to use the websocket without receiving an error.
+
+## Branch Structure
+
+When developing either in the repository if you are a contributor, or from a fork, please follow these conventions when creating new branches.
+
+| Branch Name | Explanation                                                                                                                                               |
+|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
+| main        | The main branch. This branch is set to auto-deploy to Shuttle. Never commit to this branch directly. Instead create a branch matching the ones from below.|
+| feat/*      | Any branch prefixed with "feat/" is a feature branch and contains a brand new feature                                                                     |
+| chore/*     | Any branch prefixed with "chore/" is a chore branch. Anything not involving code, like deployments, updating the README, etc, are found in these branches |
+| fix/*       | Any branch prefixed with "fix/" is a bugfix branch. These branches should only be used to fix bugs.                                                       |