mirrors/nextcloud-android
1
0
Fork 0
mirror of https://github.com/nextcloud/android.git synced 2024-11-27 17:46:37 +03:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1606 from owncloud/improved_contribution_and_setup_docs_by_sudhirkhanger

Browse source 
Improved contribution and setup docs
This commit is contained in:
David A. Velasco 2016-04-14 09:38:11 +02:00
commit 5f34b9d749
2 changed files with 5 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
CONTRIBUTING.md
View file

@ -16,7 +16,7 @@ If your issue appears to be a bug, and hasn't been reported, open a new issue.
Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.
[template]: https://raw.github.com/owncloud/android/master/issue_template.md [template]: https://raw.github.com/owncloud/android/master/issue_template.md
[mailinglist]: https://mail.kde.org/mailman/listinfo/owncloud [mailinglist]: https://mailman.owncloud.org/mailman/listinfo/user
[forum]: http://forum.owncloud.org/ [forum]: http://forum.owncloud.org/
[irc]: http://webchat.freenode.net/?channels=owncloud&uio=d4 [irc]: http://webchat.freenode.net/?channels=owncloud&uio=d4
@ -35,19 +35,10 @@ Before we're able to merge your code into the ownCloud app for Android, you need
### 1. Fork and download android/master repository: ### 1. Fork and download android/master repository:
NOTE: You must have the git installation folder in your environment variable PATH to perform the next operations. * Please follow [SETUP.md](https://github.com/owncloud/android/blob/master/SETUP.md) to setup ownCloud Android app work environment.
* In a web browser, go to https://github.com/owncloud/android, and click the 'Fork' button near the top right corner.
* In a command line prompt, clone your new repo: ```git clone git@github.com:YOURGITHUBNAME/android.git```.
* Move to the project folder with ```cd android```.
* Checkout the remote branch 'master' in your own local branch: ```git checkout -b master remotes/origin/master```.
* Pull any changes from your remote branch 'master': ```git pull origin master```
* Make official ownCloud repo known as upstream: ```git remote add upstream git@github.com:owncloud/android.git```
* Make sure to get the latest changes from official android/master branch: ```git pull upstream master```
* Make sure you read [SETUP.md](https://github.com/owncloud/android/blob/master/SETUP.md) when you start working on this project.
### 7. Create pull request: ### 2. Create pull request:
NOTE: You must sign the [Contributor Agreement][agreement] before your changes can be accepted! NOTE: You must sign the [Contributor Agreement][agreement] before your changes can be accepted!
@ -56,7 +47,7 @@ NOTE: You must sign the [Contributor Agreement][agreement] before your changes c
* Browse to https://github.com/YOURGITHUBNAME/android/pulls and issue pull request * Browse to https://github.com/YOURGITHUBNAME/android/pulls and issue pull request
* Enter description and send pull request. * Enter description and send pull request.
### 8. Create another pull request: ### 3. 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/master. 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/master.

4
SETUP.md
View file

@ -1,4 +1,3 @@
These instructions will help you to set up your development environment, get the source code of the ownCloud for Android app and build it by yourself. If you want to help developing the app take a look to the [contribution guidelines][0]. These instructions will help you to set up your development environment, get the source code of the ownCloud for Android app and build it by yourself. If you want to help developing the app take a look to the [contribution guidelines][0].
Sections 1) and 2) are common for any environment. The rest of the sections describe how to set up a project in different tool environments. Choose the build tool or IDE you prefer and follow the instructions in its specific section. Nowadays we recommend to use Android Studio (section 2), but the decision is up to you. Sections 1) and 2) are common for any environment. The rest of the sections describe how to set up a project in different tool environments. Choose the build tool or IDE you prefer and follow the instructions in its specific section. Nowadays we recommend to use Android Studio (section 2), but the decision is up to you.
@ -10,7 +9,7 @@ If you have any problem, remove the 'android' folder, start again from 1) and wo
There are some tools needed, no matter what is your specific IDE or build tool of preference. There are some tools needed, no matter what is your specific IDE or build tool of preference.
[git][1] is used to access to the different versions of the ownCloud's source code. Download and install the version appropiate for your operating system from [here][2]. Add the full path to the 'bin/' directory from your git installation into the PATH variable of your environment so that it can be used from any location. [git][1] is used to access to the different versions of the ownCloud's source code. Download and install the version appropriate for your operating system from [here][2]. Add the full path to the 'bin/' directory from your git installation into the PATH variable of your environment so that it can be used from any location.
The [Android SDK][3] is necessary to build the app. There are different options to install it in your system, depending of the IDE you decide to use. Check Google documentation about [installation][4] for more details on these options. After installing it, add the full path to the directories 'tools/' and 'platform-tools/' from your Android SDK installation into the PATH variable of your environment. The [Android SDK][3] is necessary to build the app. There are different options to install it in your system, depending of the IDE you decide to use. Check Google documentation about [installation][4] for more details on these options. After installing it, add the full path to the directories 'tools/' and 'platform-tools/' from your Android SDK installation into the PATH variable of your environment.
@ -36,7 +35,6 @@ Next steps will assume you have a Github account and that you will get the code
* Open a terminal and go on with the next steps in it. * Open a terminal and go on with the next steps in it.
* Clone your forked repository: ```git clone git@github.com:YOURGITHUBNAME/android.git```. * Clone your forked repository: ```git clone git@github.com:YOURGITHUBNAME/android.git```.
* Move to the project folder with ```cd android```. * Move to the project folder with ```cd android```.
* Checkout the remote branch 'master' in your own local branch 'master': ```git checkout master remotes/origin/master```.
* Pull any changes from your remote branch 'master': ```git pull origin master``` * Pull any changes from your remote branch 'master': ```git pull origin master```
* Make official ownCloud repo known as upstream: ```git remote add upstream git@github.com:owncloud/android.git``` * Make official ownCloud repo known as upstream: ```git remote add upstream git@github.com:owncloud/android.git```
* Make sure to get the latest changes from official android/master branch: ```git pull upstream master``` * Make sure to get the latest changes from official android/master branch: ```git pull upstream master```