Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add contribution guidelines #30

Merged
merged 1 commit into from
Aug 29, 2024
Merged

Add contribution guidelines #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contributing Documentation

## Setup
The XCode project is generated using `xcodgen`.

## Making Changes Involving the Rust Layer
During development, you can simply depend on your local instance of
`mobile-sdk-rs` by editing the `Package.swift`.

Once everything is complete, you can depend on specific commits from
`mobile-sdk-rs` as Swift's Package Manager enables it, but because of
limitations on the Android's side, you might need to publish a new version of
`mobile-sdk-rs`.

## Release
1. Ensure the dependencies rely on published versions and not commits or
branches.
2. Ensure `SpruceIDMobileSdk.podspec`'s version is bumped and that the
dependencies' versions match the versions in `Package.swift`.
3. Push a tag in the format `x.y.z` which should match the version in the
podspec.
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ only. We welcome feedback on the usability, architecture, and security of this
implementation and are committed to a conducting a formal audit with a reputable
security firm before the v1.0 release.

## Setup

The XCode project is generated using `xcodgen`.

## Architecture

Our Mobile SDKs use shared code, with most of the logic being written once in
Expand Down Expand Up @@ -40,4 +36,8 @@ called in native SDKs.

## Configuring Deep Links for same device flows

Click [here](./Sources/MobileSdk/ui/SameDeviceOID4VP.md) to see how to configure the same device OpenID4VP flow.
Click [here](./Sources/MobileSdk/ui/SameDeviceOID4VP.md) to see how to configure the same device OpenID4VP flow.

## Contributing

See [CONTRIBUTING.md](/CONTRIBUTING.md).
Loading