Merge pull request #21 from snewell92/updateNodeEnvInTravis

Making testing cross platform

Author: RobinBuschmann

.travis.yml

@@ -9,6 +9,7 @@ install:
 script:
   - npm run lint
   - npm run build
+  - export SEQ_SILENT=true
   - npm run cover
 
 after_success:

README.md

@@ -567,4 +567,27 @@ If you need to minify your code, you need to set `tableName` and `modelName`
 in the `DefineOptions` for `@Table` annotation. sequelize-typescript
 uses the class name as default name for `tableName` and `modelName`. 
 When the code is minified the class name will no longer be the originally
-defined one (So that `class User` will become `class b` for example).
+defined one (So that `class User` will become `class b` for example).
+
+
+# Contributing
+
+To contribute you can:
+- Open issues and participate in discussion of other issues.
+- Fork the project to open up PR's.
+- Update the [types of Sequelize](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sequelize).
+- Anything else constructively helpful.
+
+In order to open a pull request please:
+- Create a new branch.
+- Run tests locally (`npm install && npm run build && npm run cover`) and ensure your commits don't break the tests.
+- Document your work well with commit messages, a good PR description, comments in code when necessary, etc.
+
+In order to update the types for sequelize please go to [the Definitely Typed repo](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sequelize), it would also be a good
+idea to open a PR into [sequelize](https://github.com/sequelize/sequelize) so that Sequelize can maintain its own types, but that
+might be harder than getting updated types into microsoft's repo. The Typescript team is slowly trying to encourage
+npm package maintainers to maintain their own typings, but Microsoft still has dedicated and good people maintaining the DT repo, 
+accepting PR's and keeping quality high.
+
+**Keep in mind `sequelize-typescript` does not provide typings for `sequelize`** - these are seperate things.
+A lot of the types in `sequelize-typescript` augment, refer to, or extends what sequelize already has.

package.json

@@ -10,9 +10,9 @@
     "prepare-test-v4": "npm install [email protected] && npm run build-tests-es6",
     "test-v3": "npm run prepare-test-v3 && npm run exec-tests",
     "test-v4": "npm run prepare-test-v4 && npm run exec-tests",
-    "cover-v3": "npm run prepare-test-v3 && SEQ_SILENT=true nyc --exclude 'lib/models/v4/**/*.js' --all --require source-map-support/register mocha 'test/specs/**/*.js'",
-    "cover-v4": "npm run prepare-test-v4 && SEQ_SILENT=true nyc --exclude 'lib/models/v3/**/*.js' --all --require source-map-support/register mocha 'test/specs/**/*.js'",
-    "exec-tests": "SEQ_SILENT=true mocha 'test/specs/**/*.js'",
+    "cover-v3": "npm run prepare-test-v3 && nyc --exclude lib/models/v4/**/*.js --all --require source-map-support/register mocha test/specs/",
+    "cover-v4": "npm run prepare-test-v4 && nyc --exclude lib/models/v3/**/*.js --all --require source-map-support/register mocha test/specs/",
+    "exec-tests": "mocha test/specs/",
     "test": "npm run test-v4 && npm run test-v3",
     "cover": "npm run cover-v4 && npm run cover-v3",
     "lint": "tslint ."

test/mocha.opts

@@ -0,0 +1,2 @@
+--recursive
+