Skip to content

Latest commit

 

History

History
67 lines (50 loc) · 3.52 KB

SETUP.md

File metadata and controls

67 lines (50 loc) · 3.52 KB
Raw

If you want to start help developing ownCloud please follow the contribution guidelines and observe these instructions:

1. Fork and download ios-issues/develop repository:

NOTE: To compile the code you need xcode 6 or above.

  • Navigate to https://github.com/owncloud/ios, click fork.
  • Clone your new repo: "git clone git@github.com:YOURGITHUBNAME/ios.git"
  • Move to the project folder with "cd ios"
  • Checkout remote develop branch: "git checkout -b develop remotes/origin/develop"
  • Pull changes from your develop branch: "git pull origin develop"
  • Make official ownCloud repo known as upstream: "git remote add upstream git@github.com:owncloud/ios.git"
  • Make sure to get the latest changes from official ios-issues/develop branch: "git pull upstream develop"

2. Add the ownCloud iOS library:

NOTE: This will connect with our ownCloud iOS Library repository at "https://github.com/owncloud/ios-library".

  • Inside the folder ios:
    • Init the library submodule: "git submodule init"
    • Update the library submodule: "git submodule update"

3. Create your own certificates

NOTE: You must use the same "extension" on the certificates of the extensions (ownCloudExtApp, ownCloudExtAppFileProvider, OC-Share-Sheet)

  • Login at https://developer.apple.com/ as developer and there to to the Certificates section.
  • Create a Development Certificate for you (probably you got it one now)
  • Create an App Id for the main app. Ex: com.mywebpage.owncloud.ios
  • Create an App Id for the Document Provider. Ex: com.mywebpage.owncloud.ios.ownCloudExtApp
  • Create an App Id for the Document Provider File Provider. Ex: com.mywebpage.owncloud.ios.ownCloudExtAppFileProvider
  • Create an App Id for the Share In. Ex: com.mywebpage.owncloud.ios.OC-Share-Sheet
  • Create an AppGroup and add it too all the App Id. Must have the App Id than the main app but with the group. Ex: group.com.mywebpage.owncloud.ios
  • Add the UDID of your device on the Devices section.
  • Create 4 Development Profiles. One for each App Id.

4. Create pull request:

NOTE: You must sign the Contributor Agreement or contribute your code under the MIT license before your changes can be accepted! See the iOS license exception for testing the ownCloud iOS app on Apple hardware.

  • Remove your own App Id from the project and set again the ownCloud ones:
    • Main app: com.owncloud.iOSmobileapp
    • Document Provider: com.owncloud.iOSmobileapp.ownCloudExtApp
    • Document Provider File Provider: com.owncloud.iOSmobileapp.ownCloudExtAppFileProvider
    • Share In: com.owncloud.iOSmobileapp.OC-Share-Sheet
  • Commit your changes locally: "git commit -a"
  • Push your changes to your Github repo: "git push"
  • Browse to https://github.com/YOURGITHUBNAME/ios/pulls and issue pull request
  • Click "Edit" and set "base:develop"
  • Again, click "Edit" and set "compare:develop"
  • Enter description and send pull request.

5. Create another pull request:

To make sure your new pull request does not contain commits which are already contained in previous PRs, create a new branch which is a clone of upstream/develop.

  • git fetch upstream
  • git checkout -b my_new_develop_branch upstream/develop
  • If you want to rename that branch later: "git checkout -b my_new_develop_branch_with_new_name"
  • Push branch to server: "git push -u origin name_of_local_develop_branch"
  • Use Github to issue PR