Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

45 lines (34 loc) · 1.93 KB
Raw

How to Contribute

Our Contributing Guidelines are located in our Contributing Documentation. The documentation also includes recommended tooling, code style tips, and lots of other great information to get you started.

Notes on the Example Project

This project contains an example app called DemoPasswordless. It is important to know that if you're planning to run this app, you must configure a few things beforehand:

  1. Passkey authorization is tied directly to an apple-app-site-association (AASA) file hosted on your public API.
  2. When running the app, your developer account must be on the Apple team designated in the corresponding AASA file, along with a matching bundle ID.

For example, let's say your AASA file looks like this:

{
  "webcredentials": {
    "apps": [
      "Q999999997.com.8bit.bitwarden.passwordlessios"
    ]
  }
}

To run the demo app without errors, the app's bundle ID must be com.8bit.bitwarden.passwordlessios. Furthermore, your personal developer account must have access to the team ID Q999999997.

In the DemoServices.swift file, the relying party ID (rpID) should be set to the domain where this AASA file is hosted.

Releasing

SPM

Swift Package Manager works by pointing to release tags on main. To create a new release, simply create a new tag on the main branch.

CocoaPods

Please follow the guide from CocoaPods.org. But generally, you want to do the following:

  1. Update the version in the podspec file.
  2. Merge the podspec into main.
  3. Create a release tag on the main branch.
  4. Make sure the pod lints correctly using the following command: 
    pod spec lint
  5. With an active CocoaPod session with maintainer permissions on the pod, run the following to push to the public trunk: 
    pod trunk push