nextcloud-android/CONTRIBUTING.md

Nextcloud Android app

Index

1. Guidelines
   1. Issue reporting
   2. Labels
      1. PR
      2. Issue
2. Contributing to Source Code
   1. Developing process
   2. Contribution process
      1. Fork and download android/master repository
      2. Create pull request
      3. Create another pull request
   3. Translations
3. Releases
   1. Types
      1. Stable
      2. Release Candidate
      3. Beta
   2. Version Name and number
   3. Release cycle
   4. Release Process
      1. Stable
      2. Release Candidate
      3. Development Beta

Guidelines

Issue reporting

• Report the issue using our [template][template], it includes all the information we need to track down the issue.
• This repository is only for issues within the Nextcloud Android app code. Issues in other components should be reported in their own repositories, e.g. Nextcloud core
• Search the existing issues first, it's likely that your issue was already reported. If your issue appears to be a bug, and hasn't been reported, open a new issue.

Labels

Pull request

• 1 to develop
• 2 developing
• 3 to review
• 4 to release

Issue

• nothing
• approved
• PR exists (and then the PR# should be shown in first post)

Contributing to Source Code

Thanks for wanting to contribute source code to Nextcloud. That's great!

Developing process

We are all about quality while not sacrificing speed so we use a very pragmatic workflow.

• create an issue with feature request
  • discuss it with other developers
  • create mockup if necessary
  • must be approved --> label approved
  • after that no conceptual changes!
• develop code
• create pull request
• to assure the quality of the app, any PR gets reviewed, approved and tested by two developers before it will be merged to master

Contribution process

• Contribute your code in the branch 'master'. It will give us a better chance to test your code before merging it with stable code.
• For your first contribution start a pull request on master.

1. Fork and download android/master repository:

• Please follow SETUP.md to setup Nextcloud Android app work environment.

2. Create pull request:

• Commit your changes locally: git commit -a
• Push your changes to your GitHub repo: git push
• Browse to https://github.com/YOURGITHUBNAME/android/pulls and issue pull request
• Enter description and send 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.

• git fetch upstream
• git checkout -b my_new_master_branch upstream/master
• If you want to rename that branch later: git checkout -b my_new_master_branch_with_new_name
• Push branch to server: git push -u origin name_of_local_master_branch
• Use GitHub to issue PR

Translations

...are an open issue. Please stay with us until we have bootstrapped translations.

Releases

At the moment we are releasing the app in two app stores:

• Google Play Store
• f-droid (work in progress)

Types

We do differentiate between three different kinds of releases:

Stable

Play store and f-droid releases for the masses stable: as described, PRs that have been tested and reviewed can go to master. After the last stable beta published PR is out in the wild for ~2 weeks and no errors get reported (by users or in the developer console) the master branch is release ready. So when we decide to go for a new release we freeze the master feature wise

Release Candidate

• stable beta releases done via the Beta program of the Google Play store stable beta: whenever a PR is reviewed/approved we put it on master and do a stable beta release release candidate = tested PRs, merged to to master between stable releases, published on the Play store beta channel

Development Beta

• development beta releases done as a standalone app that can be installed in parallel to the stable app beta: anything that has a certain maturity as in a PR that can be used already but might lack some on top features or polishing beta = your awesome beta application that can be installed in parallel and contains PRs that are done in development but not necessarily to be considered stable enough for master or might even still have known bugs

##Version Name and number For stable and release candidate the version name follows the semantic versioning schema and the version number has several digits reserved to parts of the versioning schema, where:

• 2 digits for beta code
• 2 digits for hot fix code
• 3 digits for minor version code
• n digits for mayor version code

Examples for different versions:

• 1.0.0 10000000
• 8.12.2 80120200
• 9.8.4-rc18 90080418

beware, that beta releases for an upcoming version will always use the minor and hotfix version of the current release not the upcoming so that the version code of the upcoming stable release will always be higher so the current beta release can be updated to the latest hot fix release.

Release cycle

• for each release we choose several PRs that will be included in the next release. Currently there are many open PRs from ownCloud, but after merging them, the intention is to choose the PRs that are ready (reviewed, tested) to get them merged very soon.
• these will be merged into master, tested heavily, maybe automatic testing
• after feature freeze a public play store beta is released
• ~2 weeks testing, bug fixing
• release final version on f-droid and play store

##Release process

###Stable Release Stable releases are based on the git master.

1. Bump the version name and version code in the AndroidManifest.xml, see below the version name and code concept.
2. Create a release/tag in git. Tag name following the naming schema: stable-Mayor.Minor.Hotfix (e.g. stable-1.2.0) naming the version number following the semantic versioning schema

###Release Candidate Release Release Candidate releases are based on the git master and are done between stable releases.

1. Bump the version name and version code in the AndroidManifest.xml, see below the version name and code concept.
2. Create a release/tag in git. Tag name following the naming schema: rc-Mayor.Minor.Hotfix-betaIncrement (e.g. rc-1.2.0-12) naming the version number following the semantic versioning schema

###Development Beta Release Beta releases are based on the git beta and are done independently from stable releases and integrate open PRs that might not be production ready or heavily tested but being put out there for people willing to test new features and provide valuable feedback on new features to be incorporated before a feature gets released in the stable app.

1. Bump the version name and version code in the AndroidManifest.xml, see below the version name and code concept.
2. Create a release/tag in git. Tag name following the naming schema: beta-YYYYMMDD (e.g. beta-20160612)