| 1 | # Contributing
|
| 2 |
|
| 3 | Sequelize CLI is entirely driven by community contributions. Any little contribution with code or documentation work helps us keeping this project running.
|
| 4 |
|
| 5 | You can help us in various ways
|
| 6 |
|
| 7 | ## Reporting Bugs
|
| 8 |
|
| 9 | ### Security Issues
|
| 10 |
|
| 11 | Although CLI is never supposed to be web facing, we still want to fix any security issues. Please contact project maintainers **privately**. You can find more information [here](https://github.com/sequelize/sequelize/blob/master/CONTACT.md).
|
| 12 |
|
| 13 | ### General Issues or Feature Requests
|
| 14 |
|
| 15 | Github issues should follow specified template. When you start creating a new issue, an empty template will be already filled.
|
| 16 |
|
| 17 | Please make sure issue you are reporting is strictly related to Sequelize CLI.
|
| 18 |
|
| 19 | If you want to propose new features to Sequelize CLI, you may ignore issue template. You still need to clearly state new feature. Feature request should give various examples, API suggestions and references to support idea behind it.
|
| 20 |
|
| 21 | ## Fixing Bugs or Implementing Features
|
| 22 |
|
| 23 | ### Preparing your environment
|
| 24 |
|
| 25 | Start with cloning Sequelize CLI repo
|
| 26 |
|
| 27 | ```bash
|
| 28 | $ git clone git@github.com:sequelize/cli.git
|
| 29 |
|
| 30 | $ git clone https://github.com/sequelize/cli.git # Using HTTPS
|
| 31 | ```
|
| 32 |
|
| 33 | Make sure you have all required dependencies, you will need
|
| 34 |
|
| 35 | - Node v4 or above
|
| 36 | - NPM v3 or above
|
| 37 |
|
| 38 | Now go to cloned repository folder
|
| 39 |
|
| 40 | ```bash
|
| 41 | $ cd /path/to/cloned/repository
|
| 42 | ```
|
| 43 |
|
| 44 | Install required modules
|
| 45 |
|
| 46 | ```bash
|
| 47 | $ npm install
|
| 48 | ```
|
| 49 |
|
| 50 | ### Running tests
|
| 51 |
|
| 52 | By default CLI use SQLite, which requires no database configuration. We use Babel to build CLI. Running default test command will automatically build it for you.
|
| 53 |
|
| 54 | ```bash
|
| 55 | $ npm test
|
| 56 | ```
|
| 57 |
|
| 58 | Test can take about 7 to 10 minutes to finish, subjected to hardware configuration.
|
| 59 |
|
| 60 | ## Improving Documentation
|
| 61 |
|
| 62 | If you want to improve or expand our documentation you can start with documentation in `/docs` folder of this repository.
|
| 63 |
|
| 64 | You can also help by improving [Migration section](http://docs.sequelizejs.com/manual/tutorial/migrations.html). Please read more about contributing to Sequelize Docs [here](https://github.com/sequelize/sequelize/blob/master/CONTRIBUTING.DOCS.md)
|