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:
There are several ways how you can ask your question:
Preferred way if you create your question on StackOverflow, or create a github issue.
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.
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.
Before you submit your Pull Request (PR) consider the following guidelines:
- 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.
- Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.git commit -aNote: 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
- 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 -igit 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 have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate changelog.
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type and a subject:
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
If the commit reverts a previous commit, it should begin with
revert:, followed by the header of the reverted commit. In the body it should say:
This reverts commit <hash>., where the hash is the SHA of the commit being reverted.
Must be 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
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
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.
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.
Fix and close issue:
fix: resolve issues uppercase column names
Implement new feature:
feat: implement new magic decorator
This new feature change bahviour of typeorm to allow use new magic decorator...
docs: update supported mssql column types
refactor: refactor driver API
BREAKING CHANGE: description of breaking change in driver API
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.