4. testing-your-changes.md

Contribution Guide

1. Getting Set up
2. Building Samples and Packages
3. Running a Sample or Storybook
4. Testing your changes
5. Writing unit tests
6. Submitting a PR
7. Having your changes published

4. Testing your changes

The key ways to test your changes are:

• Unit tests (see 5. Writing unit tests)
• Tests in the sample apps (see 3. Running a Sample)
• Tests in Storybook (see 3. Running Storybook)
• Automated tests (see Automated tests)
• Accessibility tests (see Accessibility tools)

Testing changes in your app

A common scenario is that you encountered a bug in your app and are looking to submit a fix but want to test the fix works in your app. To test changes made in this repo inside your app follow the following process:

1. Make your changes to the necessary packages in this repo

2. Build those packages using the rush command rush build -t "package-name"

3. Npm pack your changes to migrate them to your repo

   • Run npm pack in the package directory

     # inside the root of the package you wish to test in your app
     npm pack

   • This will produce a tarball file package-name.tar.gz

4. Copy and paste this tarball into your app's root directory

5. Install the tarball as a dependency in your app:

   npm install "package-name.tar.gz"

6. You will need to repeat this process for each package you have made changes to

---

• Next: Writing unit tests
• Previous: Running a Sample or Storybook