-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update how to contribute docs (#1553)
- Loading branch information
1 parent
9b81206
commit ef06cfe
Showing
1 changed file
with
3 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,12 +4,12 @@ layout: docs | |
permalink: /development/how-to-develop.html | ||
--- | ||
|
||
As an open source project, contributions are always welcome. Before you start, please read our <a href = "https://github.com/TextureGroup/Texture/blob/master/CONTRIBUTING.md">Contribution Guidelines</a>. It's also a good idea to familiarize yourself with our <a href = "overview.html">Development documentations</a>. | ||
As an open source project, contributions are always welcome. Before you start, please read our [Contribution Guidelines](https://github.com/TextureGroup/Texture/blob/master/CONTRIBUTING.md). It's also a good idea to familiarize yourself with our [Development documentations](overview.html). | ||
|
||
Setting up your dev environment: | ||
- If you don't have CocoaPods installed on your machine yet, you should <a href = "https://guides.cocoapods.org/using/getting-started.html#getting-started">install it</a> now. | ||
- If you don't have CocoaPods installed on your machine yet, you should [install it](https://guides.cocoapods.org/using/getting-started.html#getting-started) now. | ||
- Clone the framework's source code to your machine: `git clone [email protected]: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. | ||
- To run the test suite, make sure you select the same <a href = "https://github.com/TextureGroup/Texture/blob/32a2ebf49b797b0ba2a74f2af44457a9aa7b1160/build.sh#L3">device configuration we are using for our CI</a>, which is an iPhone 7 running iOS 10.2. This is important as our snapshot tests only have snapshots captured on such device configuration. | ||
- Run `./build.sh all` locally and ensure all tests pass. Also make sure you're running the same Xcode version and Cocoapods version as the CI (currently Xcode 10.2.1 and Cocoapods 1.6). [xcversion](https://github.com/xcpretty/xcode-install) is a handy tool for keeping multiple versions of Xcode installed. You'll also need the correct [simulator device configuration](https://github.com/TextureGroup/Texture/blob/32a2ebf49b797b0ba2a74f2af44457a9aa7b1160/build.sh#L3) available. | ||
- To run one of our sample projects, run `pod install` in the sample's directory and open the generated workspace. |