| 1 | # Contributing
|
| 2 |
|
| 3 | This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
| 4 | Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
| 5 | the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
|
| 6 |
|
| 7 | When you submit a pull request, a CLA bot will automatically determine whether you need to provide
|
| 8 | a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
|
| 9 | provided by the bot. You will only need to do this once across all repos using our CLA.
|
| 10 |
|
| 11 | This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
| 12 | For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
| 13 | contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
| 14 |
|
| 15 | # How to contribute to the Application Insights Node.js SDK
|
| 16 |
|
| 17 |
|
| 18 | 1. Fork this repo
|
| 19 | 2. Clone your fork locally (`git clone https://github.com/<youruser>/ApplicationInsights-node.js
|
| 20 | 3. Open a terminal and move into your local copy (`cd ApplicationInsights-node.js`)
|
| 21 | 4. Install all dependencies with `npm install`.
|
| 22 | 5. Build project
|
| 23 | ```bash
|
| 24 | npm run build
|
| 25 | ```
|
| 26 | 6. Run unit tests
|
| 27 | ```bash
|
| 28 | npm run test
|
| 29 | ```
|
| 30 | 7. Run functional and back compatibility tests, start docker then run following commands:
|
| 31 | ```bash
|
| 32 | npm run functionaltest
|
| 33 | ```
|
| 34 | _Note: Functional tests require Docker_
|
| 35 |
|
| 36 | 8. Run back compatibility tests to ckeck older version of Node.js runtime and Typescript.
|
| 37 | ```bash
|
| 38 | npm run backcompattest
|
| 39 | ```
|
| 40 | --- |
| \ | No newline at end of file |