Skip to content

Commit

Permalink
contribution guide reviewed
Browse files Browse the repository at this point in the history
  • Loading branch information
rusher committed Jul 5, 2018
1 parent 3133174 commit 3af811f
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions documentation/developers-guide.md
Expand Up @@ -3,7 +3,8 @@

Each pull request should address a single issue, and contain both the fix as well as a description of how the pull request and tests that validate that the PR fixes the issue in question.

For significant feature additions, we like to have an open issue in [[https://mariadb.atlassian.net/secure/RapidBoard.jspa?projectKey=CONJS|MariaDB JIRA]]. It is expected that discussion will have taken place in the attached issue.
For significant feature additions, we like to have an open issue in [MariaDB JIRA](https://jira.mariadb.org/projects/CONJS).
It is expected that discussion will have taken place in the attached issue.

# Fork source

Expand All @@ -28,18 +29,21 @@ You can change those parameter by setting environment variables :


You can launch a specific test using :

{{{
```bash
node.exe .\node_modules\mocha\bin\_mocha .\test\integration\test.js
}}}
```
or whole test suite with :
```bash
npm test
```

= Run CI test
# Run CI test

Testing configuration is set for [appveyor](https://www.appveyor.com/) and [travis](https://www.travis-ci.org/).
You have to enable your travis/appveyor to validate your fork.
The advantage compared to running test locally is that it will launch tests for different version of node.js and MariaDB/MySQL servers.

For that, you have to go on [[https://travis-ci.org|travis website]], connect with your github account, and activate your mariadb-connector-nodejs repository.
For that, you have to go on [travis website](https://travis-ci.org), connect with your github account, and activate your mariadb-connector-nodejs repository.
After this step, every push to your repository will launch a travis test.

## Submitting a request
Expand Down

0 comments on commit 3af811f

Please sign in to comment.