Skip to content
README.md 4.08 KiB
Newer Older
Marino Faggiana's avatar
Marino Faggiana committed
# [Nextcloud](https://nextcloud.com)  iOS app [![Releases](https://img.shields.io/github/release/nextcloud/ios.svg)](https://github.com/nextcloud/ios/releases/latest)
Marino Faggiana's avatar
Marino Faggiana committed

Marino Faggiana's avatar
Marino Faggiana committed
[<img src="Animation.gif"
Marino Faggiana's avatar
Marino Faggiana committed
alt="Download from App Store"
Marino Faggiana's avatar
Marino Faggiana committed
height="400">](https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8)
Marino Faggiana's avatar
Marino Faggiana committed

[![irc](https://img.shields.io/badge/IRC-%23nextcloud--mobile%20on%20freenode-blue.svg)](https://webchat.freenode.net/?channels=nextcloud-mobile)

Marino Faggiana's avatar
Marino Faggiana committed
Check out https://nextcloud.com and follow us on [twitter.com/nextclouders](https://twitter.com/nextclouders) or [twitter.com/NextcloudiOS](https://twitter.com/NextcloudiOS)
Marino Faggiana's avatar
Marino Faggiana committed

HerrH's avatar
HerrH committed
## How to contribute
Marino Faggiana's avatar
Marino Faggiana committed
If you want to [contribute](https://nextcloud.com/contribute/) to Nextcloud, you are very welcome:
Marino Faggiana's avatar
Marino Faggiana committed

Marino Faggiana's avatar
Marino Faggiana committed
- on our IRC channels [![irc](https://img.shields.io/badge/IRC-%23nextcloud%20on%20freenode-orange.svg)](https://webchat.freenode.net/?channels=nextcloud) and [![irc](https://img.shields.io/badge/IRC-%23nextcloud--mobile%20on%20freenode-blue.svg)](https://webchat.freenode.net/?channels=nextcloud-mobile) on freenode
Marino Faggiana's avatar
Marino Faggiana committed
- our forum at https://help.nextcloud.com/c/clients/ios
Marino Faggiana's avatar
Marino Faggiana committed
- for translations of the app on [Transifex](https://www.transifex.com/nextcloud/nextcloud/dashboard/)
- opening issues and PRs (including a corresponding issue)
Marino Faggiana's avatar
Marino Faggiana committed

Marino Faggiana's avatar
Marino Faggiana committed
## Contribution Guidelines & License
Marino Faggiana's avatar
Marino Faggiana committed

Marino Faggiana's avatar
Marino Faggiana committed
[GPLv3](LICENSE.txt) with [Apple app store exception](COPYING.iOS).
HerrH's avatar
HerrH committed

Marino Faggiana's avatar
Marino Faggiana committed
Nextcloud doesn't require a CLA (Contributor License Agreement). The copyright belongs to all the individual contributors. Therefore we recommend that every contributor adds following line to the header of a file, if they changed it substantially:

```
@copyright Copyright (c) <year>, <your name> (<your email address>)
```

Please read the [Code of Conduct](https://nextcloud.com/code-of-conduct/). This document offers some guidance to ensure Nextcloud participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other.

More information how to contribute: [https://nextcloud.com/contribute/](https://nextcloud.com/contribute/)
Marino Faggiana's avatar
Marino Faggiana committed

## Start contributing
HerrH's avatar
HerrH committed

Marino Faggiana's avatar
Marino Faggiana committed
You can start by forking this repository and creating pull requests on the develop
branch. Maybe start working on [starter issues](https://github.com/nextcloud/ios/issues?q=is%3Aopen+is%3Aissue+label%3A%22starter+issue%22). 

Easy starting points are also reviewing [pull requests](https://github.com/nextcloud/ios/pulls)

### Xcode Project Setup

#### Dependencies

marinofaggiana's avatar
marinofaggiana committed
After forking a repository you have to build the dependencies. Dependencies are managed with Carthage version 0.37.0 or later. 
marinofaggiana's avatar
marinofaggiana committed
carthage update --use-xcframeworks --platform iOS --cache-builds
```
to fetch and compile the dependencies.
Marino Faggiana's avatar
Marino Faggiana committed

Jan Rose's avatar
Jan Rose committed
### Creating Pull requests

#### DCO Signoff

Nextcloud enforces the [Developer Certificate of Origin (DCO)](https://developercertificate.org/) on Pull Requests. It requires your commit messages to contain a Signed-off-by line with an email address that matches your GitHub account.

karan911's avatar
karan911 committed
##### How to Sign off
Jan Rose's avatar
Jan Rose committed

The DCO is a way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing by adding a Signed-off-by line to commit messages.

```
My Commit message

Signed-off-by: Random Contributor <random@contributor.dev>
```

Git even has a `-s | --signoff` command line option to append this to your commit messages automatically.

Marino Faggiana's avatar
Marino Faggiana committed
## Support
Marino Faggiana's avatar
Marino Faggiana committed

Marino Faggiana's avatar
Marino Faggiana committed
If you need assistance or want to ask a question about the iOS app, you are welcome to [ask for support](https://help.nextcloud.com/c/clients/ios) in our forums or the [IRC-Channel](https://webchat.freenode.net/?channels=nextcloud-mobile). If you have found a bug, feel free to [open a new Issue on GitHub](https://github.com/nextcloud/ios/issues). Keep in mind, that this repository only manages the iOS app. If you find bugs or have problems with the server/backend, you should ask the [Nextcloud server team](https://github.com/nextcloud/server) for help!
Marino Faggiana's avatar
Marino Faggiana committed

## TestFlight 

karan911's avatar
karan911 committed
Do you want to try the latest version in development of Nextcloud iOS ? Simple, follow this simple step
Marino Faggiana's avatar
Marino Faggiana committed

[Apple TestFlight](https://testflight.apple.com/join/GjNbfo2a)