chore: some minor changes and adding in contributing guidelines, changelog generation and pre commit hook

Author: RyanTheAllmighty

.gitignore

@@ -8,4 +8,7 @@ node_modules/
 npm-debug.log
 
 # lerna debug log
-lerna-debug.log
+lerna-debug.log
+
+# changelog directory
+.changelog

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+So you want to contribute to ATLauncher? Well here are a few ways you can help make this project better!
+
+## Branching structure
+When contributing please follow our branching structure when making a PR. Not following this will result in automatic
+closure of the PR.
+
+Our branching structure is based on
+[Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow).
+
+ - **master** will always contain the code for the latest production release
+ - **develop** will contain the latest beta version used for testing
+ - **feature/*** will contain single issues being developed. Once developed they're merged into develop and tagged with
+                 a beta release version. They should be named 'feature/22-some-brief-description'
+ - **release/*** will contain all the code from each feature branch that are going out in the next release and should
+                 all be merged into the branch. Once approved and tested it gets merged into master and tagged. They
+                 should be named 'release/4-1-1-release'
+ - **hotfix/*** will contain hotfixes going to be merged directly into master then tagged. Hotfixes should only need to
+                occur when there is a very critical bug in the current release that needs to be fixed ASAP. All hotfix
+                branches should be branched off of master.
+
+All tags are done on release of a beta or a production version and should be in format **v(version number)** and the
+version number being that of a semver number.
+
+All develop releases should be tagged with **beta** versions. For instance **v4.1.1-beta.1.6** where the NPM package
+version would be **4.1.1-beta.1.6**. Alpha versions shouldn't be used.
+
+Feature branches are deleted once in a release branch. Any issues that come up after the features branch has been merged
+nto a release branch should be resolved by creating a new feature branch off the release branch.
+
+An example of a good name for a feature branch is say we have an issue (#44) which is about not being able to delete a
+pack. A good name for a feature branch would be `feature/44-unable-to-delete-packs` and go from there.
+
+## Code styling
+When creating a PR all code you've committed will be linted against our defined ESLint rules. You can check if your code
+follows our standards by running the `npm run lint` command. More information about our ESLint rules can be found
+[here](https://github.com/ATLauncher/style-guide/tree/master/packages/eslint-config-atlauncher).
+
+In short please note the following:
+
+ - All line lengths should be under 120 lines long.
+ - 4 spaces in all files (other than json files which use 2 spaces).
+ - Unix newlines should **ALWAYS** be used.
+ - Single quotes should be used everywhere when possible except for JSON.
+ - All code should contain correct JSDoc documentation.
+ 
+## Testing
+All new code created should be properly tested with both unit and end to end tests where appropriate.
+
+Please don't over test your code, we don't aim for complete code coverage and don't even use that as a metric, we simply
+want to make sure all code is tested for typical happy and sad paths, making sure as many use cases are accounted for.
+
+## Discord
+If you wish to join our Discord channel please do so [here](https://atl.pw/discord). There is a channel specifically for
+NEXT discussion called **#atlauncher-next** which you can feel free to contribute to.

README.md

@@ -51,5 +51,12 @@ npm install --global lerna
 Then go ahead and run a `npm install` in this directory. This will bootstrap all the packages which will run a npm
 install and link and cross dependencies.
 
+Then to get up and developing with the modules, simply run `npm run storybook:dev` which will start a server at
+`http://127.0.0.1:9001` with the storybook for the `ui-components` package.
+
+To run the linter simply run `npm run lint` which will run the linter on all the packages.
+
+To run tests on all the packages, simply run `npm run test`.
+
 ## Publishing
 TBD

lerna.json

@@ -3,5 +3,13 @@
   "packages": [
     "packages/*"
   ],
+  "changelog": {
+    "repo": "ATLauncher/style-guide",
+    "labels": {
+      "bug": "Bug fix",
+      "cleanup": "Housekeeping"
+    },
+    "cacheDir": ".changelog"
+  },
   "version": "independent"
 }

package.json

@@ -1,15 +1,17 @@
 {
   "devDependencies": {
+    "husky": "^0.13.3",
     "lerna": "2.0.0-beta.38"
   },
   "scripts": {
     "copy-common-files": "node scripts/copy-common-files.js",
     "clean": "lerna run clean",
     "lint": "lerna run lint",
     "npm:prune": "lerna exec -- npm prune",
+    "precommit": "npm run lint && npm run test",
     "postinstall": "lerna bootstrap",
-    "storybook:dev": "lerna run --scope @atlauncher/ui-components storybook:dev",
-    "storybook:publish": "lerna run --scope @atlauncher/ui-components storybook:publish",
+    "storybook:dev": "lerna run --scope @atlauncher/ui-components storybook:dev --stream",
+    "storybook:publish": "lerna run --scope @atlauncher/ui-components storybook:publish --stream",
     "test": "lerna run test"
   }
 }