Sfoglia il codice sorgente

Added scope and open features section in CONTRIBUTING.md file

Andrea Bizzotto 8 anni fa
parent
commit
e83e6efe0a
1 ha cambiato i file con 28 aggiunte e 0 eliminazioni
  1. 28 0
      CONTRIBUTING.md

+ 28 - 0
CONTRIBUTING.md

@@ -4,6 +4,12 @@ All contributions to SwiftyStoreKit are welcome. 😎
 
 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](https://developer.apple.com/reference/storekit).
+
+While SwiftyStoreKit offers access to the [local receipt data](https://developer.apple.com/reference/foundation/bundle/1407276-appstorereceipturl), 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).
+
 ## Pull requests
 
 The project uses [gitflow](http://nvie.com/posts/a-successful-git-branching-model/) as a branching model.
@@ -15,6 +21,28 @@ In short:
 * The maintainer(s) will merge `develop` into `master` and create a release tag as new features are added.
 * All releases [can be found here](https://github.com/bizz84/SwiftyStoreKit/releases).
 
+## Open Features / Enhancement Requests
+
+#### Local Receipt validation
+
+SwiftyStoreKit offers a reference implementation for [receipt validation with Apple](https://github.com/bizz84/SwiftyStoreKit/blob/master/SwiftyStoreKit/AppleReceiptValidator.swift).
+
+This could be extended by implementing local receipt validation as recommended by Apple. See [related issue](https://github.com/bizz84/SwiftyStoreKit/issues/101).
+
+#### Support for content hosted by Apple for non-consumable products
+
+See [related issue](https://github.com/bizz84/SwiftyStoreKit/issues/128).
+
+#### 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](https://github.com/bizz84/SwiftyStoreKit/blob/master/SwiftyStoreKit/SwiftyStoreKit.swift).
+- [ ] Unit tests for receipt verification code.
+
+See [related issue](https://github.com/bizz84/SwiftyStoreKit/issues/38).
+
 
 ## Issues