Skip to content

Latest commit

 

History

History
69 lines (37 loc) · 3.85 KB

CONTRIBUTING.md

File metadata and controls

69 lines (37 loc) · 3.85 KB
Raw

Contributing to SwiftyStoreKit

All contributions to SwiftyStoreKit are welcome. 😎

This project is becoming widely adopted and its growth is now limited by the time the main maintainer can allocate.

Going forward, the aim is to transfer some of the maintainance and development effort to the community.

If you want to help developing SwiftyStoreKit, please look for issues marked with a blue contributions welcome label. See this issue for an example.

The maintainer will use this label initially for simple tasks that are appropriate for beginners and first time contributors.

As the project and its community grows:

  • intermediate and advanced tasks will be opened up to contributors
  • most experienced contributors will be able to gain admin rights to review and merge pull requests

Note: While the maintainer(s) try to regularly keep the project alive and healthy, issues and pull requests are not always reviewed in a timely manner. 🕰

Scope

SwiftyStoreKit aims to be a lightweight wrapper on top of StoreKit.

While SwiftyStoreKit offers access to the local receipt data, it is a non-goal to add support for persisting IAP data locally. It is up to clients to do this with a storage solution of choice (i.e. NSUserDefaults, CoreData, Keychain).

Swift Version: SwiftyStoreKit includes Swift 2.3 and Swift 2.2 branches. These legacy versions are no longer maintained and all active development happens on master and develop, which support Swift 3.x and Swift 4.x.

Objective-C: Currently, SwiftyStoreKit cannot be used in Objective-C projects. The main limitation is that most classes and types in the library are Swift-only. See related issue.

Pull requests

The project uses gitflow as a branching model.

In short:

  • All pull requests for new features and bug fixes should be made into the develop branch.
  • Pull requests for hot fixes can be done into both master and develop.
  • The maintainer(s) will merge develop into master and create a release tag as new features are added.
  • All releases can be found here.

Open Features / Enhancement Requests

These are intermediate / advanced tasks that will hopefully be implemented in the future:

Local Receipt validation

SwiftyStoreKit offers a reference implementation for receipt validation with Apple.

This could be extended by implementing local receipt validation as recommended by Apple. See related issue.

Support for content hosted by Apple for non-consumable products

See related issue.

Increase unit test coverage

The payment flows are unit tested fairly extensively. Additional unit test coverage is welcome:

  • Dependency injection for SwiftyStoreKit dependencies
  • Unit tests on main SwiftyStoreKit class.
  • Unit tests for receipt verification code.

See related issue.

Issues

If SwiftyStoreKit doesn't work as you expect, please review any open issues before opening a new one.