We would love for you to contribute to TypeORM and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:
There are several ways how you can ask your question:
- You can create a question on StackOverflow where the questions should be tagged with tag
typeorm. - You can ask on Slack
- You can create issue on github
- If you have a Skype then try to find me there (
Umed Khudoiberdiev)
Preferred way if you create your question on StackOverflow, or create a github issue.
If you find a security vulnerability or something that should be discussed personally, please contact me within my email.
If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.
You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:
- For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
- Small Features can be crafted and directly submitted as a Pull Request.
Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we ask you to provide a minimal code snippet that shows a reproduction of the problem.
You can file new issues by filling out our new issue form.
Before you submit your Pull Request (PR) consider the following guidelines:
-
Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.
-
Make your changes in a new git branch:
git checkout -b my-fix-branch master
-
Create your patch, including appropriate test cases. Without tests your PR will not be accepted.
-
Add changelog record (short description, link to PR or issues) to the Unreleased section of
CHANGELOG.md. -
Run the full TypeORM test suite, as described in the developer documentation, and ensure that all tests pass.
-
Commit your changes using a descriptive commit message
git commit -a
-
Push your branch to GitHub:
git push origin my-fix-branch
-
In GitHub, send a pull request to
typeorm:master. -
If we suggest changes then:
-
Make the required updates.
-
Re-run the TypeORM test suites to ensure tests are still passing.
-
Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
git rebase master -i git push -f
-
That's it! Thank you for your contribution!
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
-
Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
git push origin --delete my-fix-branch
-
Check out the master branch:
git checkout master -f
-
Delete the local branch:
git branch -D my-fix-branch
-
Update your master with the latest upstream version:
git pull --ff upstream master
We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
Thank you to all the people who have already contributed to typeorm!
Thank you to all our backers! [Become a backer]
Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)
