Skip to content

Latest commit

 

History

History
57 lines (41 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

57 lines (41 loc) · 2.78 KB
Raw

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Welcome

Welcome and thank you for your interest in contributing to ApplicationInsights-JS.

We strongly welcome and encourage contributions to this project. Please read the contributor's guide located in the ApplicationInsights-Home repository. If making a large change we request that you open an issue first. We follow the Git Flow approach to branching.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Clone and setup

  1. Clone the repository and create a new branch
  2. Install all dependencies 
    npm install
npm install -g @microsoft/rush
  3. Navigate to the root folder and update rush dependencies 
    rush update
  4. Build and test 
    rush build
npm run test

Build and test

The root folder contains 8 packages that are components of this next version of the SDK. When making changes in multiple packages, you can build using the following commands in root folder:

  1. rush rebuild --verbose

    This will build all packages in order of dependencies. If there are build errors, verbose options is required to view error details.

  2. rush test --verbose

    This will run tests in all packages in parallel.

If you are changing package versions or adding/removing any package dependencies, run> rush update --purge --recheck --full before building. Please check-in any files that change under common\ folder.