Skip to content

Commit c3f8b3f

Browse files
Create CONTRIBUTING.md
1 parent f46fc97 commit c3f8b3f

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

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

0 commit comments

Comments
 (0)