1. getting-set-up.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

1. Getting Set up

Prerequisites

• Install Node.js (16.19.0 and above).

• (Recommended) Install Visual Studio Code (Stable Build).

• Install Rush, in a terminal of your choosing, run:

  npm i -g @microsoft/rush

Cloning the repo

Clone the repo: https://github.com/Azure/communication-ui-library

# HTTPS
git clone https://github.com/Azure/communication-ui-library.git

# SSH
git clone [email protected]:Azure/communication-ui-library.git

Installing dependencies

Navigate to your cloned repo and install dependencies for all packages and samples:

# navigate to the repository
cd communication-ui-library/

# install dependencies
rush update

note: this may take a long time the first time it runs

FAQ

If you are running into issues such as "Filename too long" when setting up the repo. e.g

error: cannot stat 'packages/react-composites/tests/browser/snapshots/stable/tests/browser/callwithchat/CallWithChatComposite.test.ts-snapshots/call-with-chat-more-drawer-new-selected-microphone-screen-Mobile-Android-Portrait-linux.png': Filename too long

We suggest running this command

git config --system core.longpaths true

or without --system git config core.longpaths true

---

• Next: Building Samples and Packages