Skip to content

Latest commit

 

History

History
160 lines (115 loc) · 5.73 KB

CONTRIBUTING.md

File metadata and controls

160 lines (115 loc) · 5.73 KB
Raw

Smile Identity iOS SDK

Overview

This repo contains all the code required to run the Smile Identity SDK. The project folder structure is described below.

  • Example - A sample app that demonstrates the SDKs features
  • Sources- Contains all UI, CV and networking source code
  • Tests- Unit tests for the SDK business logic

We use mint for running swift command line tool packages. We use rake for task automation.

Requirements

  • iOS 13 or higher
  • Xcode 14 or higher

Sentry setup (Sample app only)

export SENTRY_DSN='your_sentry_dsn'

Run the following command to install the required variable for use in the example app

bundle exec arkana -c .arkana.yml -l swift

bundle exec rake test:package

SDK Tests

bundle exec rake test:package

Example App Tests

bundle exec rake test:example

CI Setup

The GITHUB_PAT_IOS_CERTIFICATES_REPO_B64 secret is created by running

echo -n smileidentity:your_personal_access_token | base64

your_personal_access_token is the fine-grained personal access token created that has permissions to the smileidentity/ios-certificates repo.

A new token can be obtained at https://github.com/settings/personal-access-tokens/new

Optional: Code Formatting and Quality Checks

To ensure our project maintains high-quality standards and consistency across contributions, we leverage the pre-commit framework for automated code formatting and quality checks. This tool helps us enforce coding standards, perform syntax checks, and automatically format code according to predefined rules before commits are made, reducing the need for manual code review for stylistic concerns.

Setting Up pre-commit in Your Development Environment

  1. Install pre-commit: To get started, you need to have pre-commit installed on your local machine. You can install it using Homebrew (for macOS users), pip (for Python users), or another method detailed in the official pre-commit installation guide.

    # Using Homebrew
brew install pre-commit

# Using pip
pip install pre-commit

  2. Install the Pre-commit Hooks: Navigate to the root of the cloned repository and install the pre-commit hooks defined in our .pre-commit-config.yaml file:

    pre-commit install

This setup process ensures that the pre-commit hooks are triggered automatically before each commit, applying code formatting and running any configured checks.

Other Notes

When contributing code to the project, please ensure your contributions adhere to the formatting standards and quality checks enforced by our pre-commit hooks. Here's what you need to know:

  • pre-commit hook It is recommended to set up a pre-commit hook (SwiftFormat - formatting, SwiftLint - swift lints). To do so, add the following to .git/hooks/pre-commit this will lint, format as well as detect additions or deletion of SDK only swift files which is essential to keep the project files in sync since we use the sample app/cocoapods for primary development and this may affect carthage releases if files are not in sync

#!/bin/sh

Path to the XCode pro update script

RUBY_SCRIPT_PATH="./Scripts/update_compile_sources.rb" swift_files_added_removed=false xcodeproj_modified=false

Check for added or deleted Swift files in "Sources" folder and its subfolders

if git diff --cached --name-status | grep -E '^[AD][[:space:]]Sources/.*.swift$'; then swift_files_added_removed=true fi

Check if the .xcodeproj file is modified and staged

if git diff --cached --name-only | grep -e 'SmileID.xcodeproj/project.pbxproj$'; then xcodeproj_modified=true fi

Get a list of all staged Swift files

STAGED_SWIFT_FILES=$(git diff --cached --name-only --diff-filter=ACMR | grep '.swift$')

echo "Automatically running SwiftFormat on all staged Swift files..." echo $STAGED_SWIFT_FILES | xargs swiftformat

Exit early if no Swift files are staged

if [ -z "$STAGED_SWIFT_FILES" ]; then exit 0 fi

Run SwiftLint for each staged Swift file

echo "Running SwiftLint..." SWIFTLINT_FAILED=0 for FILE in $STAGED_SWIFT_FILES; do swiftlint lint --quiet --path "$FILE" if [ $? -ne 0 ]; then SWIFTLINT_FAILED=1 fi done

Exit with an error if SwiftLint failed

if [ $SWIFTLINT_FAILED -ne 0 ]; then echo "Swift files formatted with SwiftFormat and added to staging"

Optionally, you could remove the exit here to allow the script to continue

exit 1 fi

Output results

if [ "$swift_files_added_removed" = true ] && [ "$xcodeproj_modified" = true ]; then echo "Added Swift files and modified .xcodeproj found." exit 0 elif [ "$swift_files_added_removed" = true ]; then # Update the XCode project file echo "Added Swift files found, but .xcodeproj is not modified, Adding to xcode project file." ruby $RUBY_SCRIPT_PATH if [ $? -ne 0 ]; then echo "Ruby script failed. Commit aborted." exit 1 fi echo "Project file updated." exit 1 fi

Otherwise, exit successfully

exit 0

- **Manual Checks**: In case linting checks fail, you'll need to review the changes, stage them, and commit again. This might include running `git add` for any automatically formatted files or making manual adjustments as suggested by the pre-commit checks.

### Further Reading and Resources

- **[SwiftLint GitHub Repository](https://github.com/realm/SwiftLint)**: Explore Swiftlint to learn more about enforcing Swift styles and conventions.
- **[SwiftFormat GitHub Repository](https://github.com/nicklockwood/SwiftFormat)**: Explore SwiftFormat for comprehensive Swift code formatting rules and configurations.