Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

33 lines (27 loc) · 2.23 KB
Raw

Fluent UI for iOS

Demo app

Included in this repository is a demo that showcases all the currently available Fluent iOS controls.

To build and run the demo app follow these steps:

  • Clone the FluentUI repository.
  • Open ios/FluentUI.xcworkspace in Xcode.
  • In the Xcode scheme menu choose Demo.development and choose an iOS Simulator(or Device if you have your own device provisioning profile) to deploy to.
  • Make sure Swift Package Manager has download 2 dependencies(appcenter-sdk-apple and PLCrashReporter) for demo app.
  • Build and Run the demo app

Adding a new component

  • Create a new folder of the Control name (ex. Foo) under under FluentUI
  • Create a new swift file. (ex. Foo.swift)
  • Add Foo.swift in Fluent xcode project (All the files are in alphabetical order)
  • Make sure your file is under FluentUILib target
  • Create and add a demo controller in the Fluent demo app under Demos (ex. FooDemoController.swift)
  • Add FooDemoController.swift to Fluent Demo xcode project (All the files are in alphabetical order)
  • Make sure it is part of FluentUI.Demo Target membership
  • Add your FooDemoController to the list of DemoDescriptor
  • Add a new cocopod subspec in MicrosoftFluentUI.podspec with required dependencies. "s.subspec 'Foo_ios' do |foo_ios|"
  • Verify by "pod spec lint" For more info on cocoapod
  • Build and Run
  • Make sure no warnings and errors. Test your components!
  • Add documentation for your new class and especially for public apis
  • Add Unit Test for FluentUITests framework

Checklist before creating a pull request

Fill out all the information in your PR description

Once your pull request has been approved by @microsoft/fluentui-native team, if you have the write access you can squash-merge your changes or @microsoft/fluentui-native team member will merge it for you.