| 1 | # To contribute you can
|
| 2 |
|
| 3 | - Open issues and participate in discussion of other issues.
|
| 4 | - Fork the project to open up PR's.
|
| 5 | - Update the [types of Sequelize](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sequelize).
|
| 6 | - Anything else constructively helpful.
|
| 7 |
|
| 8 | In order to open a pull request please:
|
| 9 |
|
| 10 | - Create a new branch.
|
| 11 | - Run tests locally (`npm install && npm run build && npm run cover`) and ensure your commits don't break the tests.
|
| 12 | - Document your work well with commit messages, a good PR description, comments in code when necessary, etc.
|
| 13 |
|
| 14 | 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
|
| 15 | idea to open a PR into [sequelize](https://github.com/sequelize/sequelize) so that Sequelize can maintain its own types, but that
|
| 16 | might be harder than getting updated types into microsoft's repo. The Typescript team is slowly trying to encourage
|
| 17 | npm package maintainers to maintain their own typings, but Microsoft still has dedicated and good people maintaining the DT repo,
|
| 18 | accepting PR's and keeping quality high.
|
| 19 |
|
| 20 | **Keep in mind `sequelize-typescript` does not provide typings for `sequelize`** - these are seperate things.
|
| 21 | A lot of the types in `sequelize-typescript` augment, refer to, or extends what sequelize already has.
|