|
48 | 48 | - [Type casting](#type-casting)
|
49 | 49 | - [Connection Flags](#connection-flags)
|
50 | 50 | - [Debugging and reporting problems](#debugging-and-reporting-problems)
|
| 51 | +- [Contributing](#contributing) |
51 | 52 | - [Running tests](#running-tests)
|
52 | 53 | - [Todo](#todo)
|
53 | 54 |
|
@@ -1314,6 +1315,31 @@ will have:
|
1314 | 1315 | * As much debugging output and information about your environment (mysql
|
1315 | 1316 | version, node version, os, etc.) as you can gather.
|
1316 | 1317 |
|
| 1318 | +## Contributing |
| 1319 | + |
| 1320 | +This project welcomes contributions from the community. Contributions are |
| 1321 | +accepted using GitHub pull requests. If you're not familiar with making |
| 1322 | +GitHub pull requests, please refer to the |
| 1323 | +[GitHub documentation "Creating a pull request"](https://help.github.com/articles/creating-a-pull-request/). |
| 1324 | + |
| 1325 | +For a good pull request, we ask you provide the following: |
| 1326 | + |
| 1327 | +1. Try to include a clear description of your pull request in the description. |
| 1328 | + It should include the basic "what" and "why"s for the request. |
| 1329 | +2. The tests should pass as best as you can. See the [Running tests](#running-tests) |
| 1330 | + section on hwo to run the different tests. GitHub will automatically run |
| 1331 | + the tests as well, to act as a safety net. |
| 1332 | +3. The pull request should include tests for the change. A new feature should |
| 1333 | + have tests for the new feature and bug fixes should include a test that fails |
| 1334 | + without the corresponding code change and passes after they are applied. |
| 1335 | + The command `npm run test-cov` will generate a `coverage/` folder that |
| 1336 | + contains HTML pages of the code coverage, to better understand if everything |
| 1337 | + you're adding is being tested. |
| 1338 | +4. If the pull request is a new feature, please be sure to include all |
| 1339 | + appropriate documentation additions in the `Readme.md` file as well. |
| 1340 | +5. To help ensure that your code is similar in style to the existing code, |
| 1341 | + run the command `npm run lint` and fix any displayed issues. |
| 1342 | + |
1317 | 1343 | ## Running tests
|
1318 | 1344 |
|
1319 | 1345 | The test suite is split into two parts: unit tests and integration tests.
|
|
0 commit comments