How to start contributing to Texture

As an open source project, contributions are always welcome. Before you start, please read our Contribution Guidelines. It’s also a good idea to familiarize yourself with our Development documentations.

Setting up your dev environment:

If you don’t have CocoaPods installed on your machine yet, you should install it now.
Clone the framework’s source code to your machine: git clone git@github.com:TextureGroup/Texture.git or git clone https://github.com/TextureGroup/Texture.git.
Run pod install in the directory that you cloned to.
Open “AsyncDisplayKit.xcworkspace” file CocoaPods has just generated. The workspace includes all the source code, as well as our test suite.
Run ./build.sh all locally and ensure all tests pass. Also make sure you’re running the same Xcode, Cocoapods and Carthage versions as the CI (currently Xcode 10.2.1, Cocoapods 1.6 and Carthage 0.33.0). xcversion is a handy tool for keeping multiple versions of Xcode installed. You’ll also need the correct simulator device configuration available.
To run one of our sample projects, run pod install in the sample’s directory and open the generated workspace.

Edit on GitHub

← Prev Next →