You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-1Lines changed: 24 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -567,4 +567,27 @@ If you need to minify your code, you need to set `tableName` and `modelName`
567
567
in the `DefineOptions` for `@Table` annotation. sequelize-typescript
568
568
uses the class name as default name for `tableName` and `modelName`.
569
569
When the code is minified the class name will no longer be the originally
570
-
defined one (So that `class User` will become `class b` for example).
570
+
defined one (So that `class User` will become `class b` for example).
571
+
572
+
573
+
# Contributing
574
+
575
+
To contribute you can:
576
+
- Open issues and participate in discussion of other issues.
577
+
- Fork the project to open up PR's.
578
+
- Update the [types of Sequelize](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sequelize).
579
+
- Anything else constructively helpful.
580
+
581
+
In order to open a pull request please:
582
+
- Create a new branch.
583
+
- Run tests locally (`npm install && npm run build && npm run cover`) and ensure your commits don't break the tests.
584
+
- Document your work well with commit messages, a good PR description, comments in code when necessary, etc.
585
+
586
+
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
587
+
idea to open a PR into [sequelize](https://github.com/sequelize/sequelize) so that Sequelize can maintain its own types, but that
588
+
might be harder than getting updated types into microsoft's repo. The Typescript team is slowly trying to encourage
589
+
npm package maintainers to maintain their own typings, but Microsoft still has dedicated and good people maintaining the DT repo,
590
+
accepting PR's and keeping quality high.
591
+
592
+
**Keep in mind `sequelize-typescript` does not provide typings for `sequelize`** - these are seperate things.
593
+
A lot of the types in `sequelize-typescript` augment, refer to, or extends what sequelize already has.
0 commit comments