@@ -4,7 +4,7 @@ The sequelize documentation is written in a combination of markdown (articles an
...
@@ -4,7 +4,7 @@ The sequelize documentation is written in a combination of markdown (articles an
All documentation is located in the `docs` folder.
All documentation is located in the `docs` folder.
The documentation is rendered using [esdoc](http://esdoc.org) and continously deployed to [Surge](http://surge.sh). esdoc generates static HTML from the code comments.
The documentation is rendered using [esdoc](http://esdoc.org) and continuously deployed to [Surge](http://surge.sh). ESdoc generates static HTML from the code comments.
All pages in the documentation are defined in the `manual` section of `.esdoc.json`. Each page is given as a separate line:
All pages in the documentation are defined in the `manual` section of `.esdoc.json`. Each page is given as a separate line:
@@ -91,7 +91,7 @@ Now launch the docker mysql and postgres servers with this command (you can add
...
@@ -91,7 +91,7 @@ Now launch the docker mysql and postgres servers with this command (you can add
$ docker-compose up postgres-95 mysql-57
$ docker-compose up postgres-95 mysql-57
```
```
Sequelize uses the sushantdhiman/postgres:9.5 Docker image for PostgreSQL, which installs the extensions required by tests: https://github.com/sushantdhiman/sequelize-postgres/blob/master/00-extensions.sql
Sequelize uses [special](https://github.com/sushantdhiman/sequelize-postgres) Docker image for PostgreSQL, which install all the extensions required by tests.
### 4. Running tests
### 4. Running tests
...
@@ -121,9 +121,7 @@ Example:
...
@@ -121,9 +121,7 @@ Example:
feat(pencil): add 'graphiteWidth' option
feat(pencil): add 'graphiteWidth' option
Commit messages are used to automatically generate a changelog, so make sure to follow the convention.
Commit messages are used to automatically generate a changelog. They will be validated automatically using [commitlint](https://github.com/marionebl/commitlint)
If you are unsure, you can let [commitizen](https://github.com/commitizen/cz-cli) ask you questions and commit for you (just run `node_modules/.bin/git-cz`).
When you commit, your commit message will be validated automatically with [validate-commit-msg](https://github.com/kentcdodds/validate-commit-msg).
Then push and send your pull request. Happy hacking and thank you for contributing.
Then push and send your pull request. Happy hacking and thank you for contributing.
...
@@ -133,8 +131,6 @@ Have a look at our [.eslintrc.json](https://github.com/sequelize/sequelize/blob/
...
@@ -133,8 +131,6 @@ Have a look at our [.eslintrc.json](https://github.com/sequelize/sequelize/blob/
# Publishing a release (For Maintainers)
# Publishing a release (For Maintainers)
**Note:** _You really don't need this as Sequelize use semantic-release, Travis will automatically release new version_
1. Ensure that latest build on master is green
1. Ensure that latest build on master is green
2. Ensure your local code is up to date (`git pull origin master`)
2. Ensure your local code is up to date (`git pull origin master`)
3.`npm version patch|minor|major` (see [Semantic Versioning](http://semver.org))
3.`npm version patch|minor|major` (see [Semantic Versioning](http://semver.org))