archive-gh-me/typeorm
1
0
Fork 0
mirror of https://github.com/typeorm/typeorm.git synced 2025-12-08 21:26:23 +00:00
Code Issues Projects Releases Wiki Activity

improved contributing and developer docs

Browse Source
This commit is contained in:
Umed Khudoiberdiev 2016-12-07 15:02:30 +05:00
parent aefa33e5d8
commit c35333a6be
2 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -12,12 +12,17 @@ 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](stackoverflow.com/questions/tagged/typeorm) where the questions should be tagged with tag `typeorm`.
* You can create a question on [StackOverflow](https://stackoverflow.com/questions/tagged/typeorm) where the questions should be tagged with tag `typeorm`.
* You can create issue on [github](https://github.com/typeorm/typeorm/issues)
* You can write your questions in our [gitter channel](https://gitter.im/pleerock/typeorm)
* If you have a Skype then try to find me there (`Umed Khudoiberdiev`)
Prefered way if you create your question on StackOverflow, or create a github issue.
Preferred way if you create your question on StackOverflow, or create a github issue.
## <a name="issue"></a> Found a security vulnerability?
If you find a security vulnerability or something that should be discussed personally,
please contact me within my [email](https://github.com/typeorm/typeorm/blob/master/package.json#L10).
## <a name="issue"></a> Found a Bug?

18
DEVELOPER.md
View File

@ -19,15 +19,16 @@ following products on your development machine:
* [Git](http://git-scm.com) and/or the **GitHub app** (for [Mac](http://mac.github.com) or
[Windows](http://windows.github.com)); [GitHub's Guide to Installing
Git](https://help.github.com/articles/set-up-git) is a good source of information.
* [Node.js](http://nodejs.org), (better to install latest version) which is used to run a development web server,
run tests, and generate distributable files.
Depending on your system, you can install Node either from source or as a pre-packaged bundle.
* [Mysql](https://www.mysql.com/) is required to run tests on this platform
* [MariaDB](https://mariadb.com/) is required to run tests on this platform
* [Postgres](https://www.postgresql.org/) is required to run tests on this platform
* [Mysql](https://www.mysql.com/) is required to run tests on this platform (or docker)
* [MariaDB](https://mariadb.com/) is required to run tests on this platform (or docker)
* [Postgres](https://www.postgresql.org/) is required to run tests on this platform (or docker)
* [Oracle](https://www.oracle.com/database/index.html) is required to run tests on this platform
* [Microsoft SQL Server](https://www.microsoft.com/en-us/cloud-platform/sql-server) is required to run tests on this platform
* For MySQL, MariaDB and Postgres you can use [docker](https://www.docker.com/) instead (docker configuration is
[here](https://github.com/typeorm/typeorm/blob/master/docker-compose.yml))
## Getting the Sources
@ -56,7 +57,7 @@ Install all TypeORM dependencies by running this command:
npm install
```
During installation you may have some probelems with some dependencies.
During installation you may have some problems with some dependencies.
For example to proper install oracle driver you need to follow all instructions from
[node-oracle documentation](https://github.com/oracle/node-oracledb).
@ -85,11 +86,14 @@ replacing parameters with your own.
Then run tests:
```shell
gulp tests
npm test
```
You should execute test suites before submitting a PR to github.
All the tests are executed on our Continuous Integration infrastructure and a PR could only be merged once the tests pass.
## Using Docker
To run your tests you need dbms installed on your machine. Alternatively, you can use docker
with all dbms images inside it. To use dbms for your tests from docker simply run `docker-compose up`
in the root of the project. Once all images are fetched and run you can run tests.