diff --git a/ios/CONTRIBUTING.md b/ios/CONTRIBUTING.md index 7d71795e97..1fe567a00e 100644 --- a/ios/CONTRIBUTING.md +++ b/ios/CONTRIBUTING.md @@ -8,11 +8,11 @@ To build and run the demo app follow these steps: - Clone the [FluentUI](https://github.com/microsoft/fluentui-apple) 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. +- Make sure Swift Package Manager has downloaded 2 dependencies(AppCenter 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](FluentUI) +- Create a new folder of the Control name (ex. Foo) under [FluentUI](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 @@ -23,11 +23,11 @@ To build and run the demo app follow these steps: - Add a new cocopod subspec in [MicrosoftFluentUI.podspec](https://github.com/microsoft/fluentui-apple/blob/main/MicrosoftFluentUI.podspec) with required dependencies. "s.subspec 'Foo_ios' do |foo_ios|" - Verify by "pod spec lint" For more info on [cocoapod](https://cocoapods.org) - Build and Run -- Make sure no warnings and errors. Test your components! -- Add documentation for your new class and especially for public apis +- Make sure there are 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](https://github.com/microsoft/fluentui-apple/blob/main/.github/PULL_REQUEST_TEMPLATE.md#pull-request-checklist) +Fill out all the information in your [PR description](https://github.com/microsoft/fluentui-apple/blob/main/.github/PULL_REQUEST_TEMPLATE.md#pull-request-checklist). 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.