Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 3.52 KB

contributing-guide.md

File metadata and controls

68 lines (44 loc) · 3.52 KB

Contribution Guide

Ways to Contribute

You can help Azure Communication UI Library with any of the following:

  • Reporting and fixing issues
  • Suggesting new features
  • Increasing unit test coverage
  • Answering any open issues
  • Improving documentation
  • Reviewing pull requests

We enthusiastically welcome contributions and feedback. You can fork the repo and start contributing now.
Here are the steps to start and develop inside iOS Mobile UI Library repo.

  1. Setup & Run Samples
  2. Submitting a PR
  3. Having your changes published

1. Setup and Run Samples

Setup Environment

  1. Begin by cloning the Repo in your local environment, cd to the AzureCommunicationUI folder in the root of the project directory.
  2. Run pod install, this generates a .xcworkspace file.
  3. Open AzureCommunicationUI.xcworkspace file generated in the above step.
  4. Hit ⌘+R to start running.

Running a Sample

For details on development guidelines and instructions on how to build and run the samples, visit the Demo App.

2. Submitting a PR

You can send pull requests to fix the open issues. For any pull request, it's recommended to open an issue and reach an agreement on an implementation design/plan with other contributors first.

We recommend making small and simple pull requests. Avoid making the implementation complicated when there is a simple, small alternative.

Please fork the repository and submit pull requests to develop branch. For details on how to set up a fork of this repository and keep it up-to-date see Fork a Repo - GitHub Help.

Writing unit tests

When submitting a pull request, please add relevant tests and ensure your changes don't break any existing tests. Pull requests should be thoroughly tested and CI checks passed.

Running unit tests

  1. Open the AzureCommunicationUI.xcworkspace with Xcode
  2. Select AzureCommunicationUICalling or AzureCommunicationUIChat scheme and target at any iOS simulator
  3. Navigate to Product -> Test or hit ⌘+U to start testing

Running UI tests

Please follow Before running the sample for the first time to have the EnvConfig.xcconfig in your project directory with necessary values for Calling or Chat.

  1. Open the AzureCommunicationUI.xcworkspace with Xcode
  2. Select AzureCommunicationUIDemoApp scheme and target at any iOS simulator/device
  3. Navigate to Product -> Test or hit ⌘+U to start testing

Style Guidelines

Azure Mobile UI Library employs a few practices to ensure the clean code and project standards. Please follow these practices to make your Pull Request consistent with the MobileUILibrary

  1. SwiftLint is added to enforce coding style and conventions
  2. Swift API Design Guidelines is the guidelines we are following
  3. Microsoft Swift Style Guide is also what we adhere to

3. Having your changes published

Once your PR is merged, your changes are ready to be published in a new version! We do manual publishes of new package versions semi-regularly.