Contributing to TypeORM

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:

Got a Question or Problem?

If you have a question or want community support:

You can create a question on StackOverflow where the questions should be tagged with tag typeorm.
You can ask on Discord

Found a security vulnerability?

If you find a security vulnerability or something that should be discussed personally, please contact me within my email.

Found a Bug?

If you find a bug in the source code, you can help us by submitting an issue to ourGitHub Repository. Even better, you can submit a Pull Request with a fix.

Missing a Feature?

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.

Submission Guidelines

Submitting an Issue

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.

Submitting a Pull Request (PR)

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.
Run the full TypeORM test suite, as described in the developer documentation, and ensure that all tests pass.
Commit your changes using descriptive commit messages. See our commit message conventions
```
git commit -a
```
Note: the optional commit -a command line option will automatically "add" and "rm" edited files.
Push your branch to GitHub:
```
git push origin my-fix-branch
```
In GitHub, send a pull request to typeorm:master and include a description following the template.
Changes can be added as new commits to the same branch, which will update your pull request.

That's it! Thank you for your contribution!

After your pull request is merged

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
```

Commit Message Guidelines

We follow the format below to help generate changelogs and keep commit history readable. We will squash and merge commits into a single commit when merging a PR to follow this convention.

If you're contributing to the project, we recommend following the same guidelines.

<type>: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Any line of the commit message should not be longer than 100 characters. This allows the message to be easier to read on GitHub as well as in various git tools.

Type

One of the following:

feat: A new feature
fix: A bug fix
docs: Documentation only changes
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
refactor: A code change that neither fixes a bug nor adds a feature
perf: A code change that improves performance
test: Adding missing tests or correcting existing tests
build: Changes that affect the build system, CI configuration or external dependencies
chore: Other changes that don't modify src or test files
revert: Reverts a previous commit. Include the hash of the commit being reverted.

Subject

The subject contains succinct description of the change:

use the imperative, present tense: "change" not "changed" nor "changes"
don't capitalize first letter
no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

Financial contributions

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.