You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -14,17 +14,7 @@ We use [semantic versioning](http://semver.org/) in our tagged releases.
14
14
15
15
##Branching Strategy
16
16
17
-
- master
18
-
+ latest stable, QA'd, tagged release of the SDK
19
-
+ assume that this is safe for production use
20
-
- sdk_MAJOR.MINOR
21
-
+ stable branch working towards the next major/minor/patch release
22
-
+ safe for checking out new features, but do not use in any production apps
23
-
- sdk_MAJOR.MINOR-dev
24
-
+ unstable development branch working towards the next major/minor/patch release
25
-
+ may not compile/run without errors
26
-
+ for development only
27
-
+ submit pull requests against this branch
17
+
We use the [successful git branching model](http://nvie.com/posts/a-successful-git-branching-model/), except without release branches, and the `develop` branch is named `dev`.
28
18
29
19
##Bug Reports & Feature Requests
30
20
@@ -36,11 +26,15 @@ If you experience a crash, please attach your symbolicated crash log or stack tr
36
26
37
27
##Pull Requests
38
28
39
-
If you would like to submit code, please fork the repository on GitHub and develop on the latest sdk-X.Y-dev branch. We do not accept pull requests on the master branch, as we only merge QA'd & tagged code into the master branch. See the description of our branching strategy above.
29
+
If you would like to submit code, please fork the repository on GitHub and develop in a feature branch, created from the latest `dev` commit. We do not accept pull requests on the `master` branch, as we only merge QA'd and tagged code into the `master` branch.
30
+
31
+
###Tests
32
+
33
+
Please include unit tests for the new/changed functionality with your pull request. It will help to verify the code is working as designed and make sure there are no regressions in future releases.
40
34
41
35
###Use of third party libraries
42
36
43
-
Connect SDK does include some third party libraries, but we try to avoid using them. If you'd like to integrate a library with a pull request, make sure that library has an open source license (MIT, Apache 2.0, etc).
37
+
Connect SDK includes some third party libraries. If you'd like to integrate a library with a pull request, make sure that library has an open source license (MIT, Apache 2.0, etc).
Copy file name to clipboardExpand all lines: README.md
+45-66Lines changed: 45 additions & 66 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
#Connect SDK Android
2
2
Connect SDK is an open source framework that connects your mobile apps with multiple TV platforms. Because most TV platforms support a variety of protocols, Connect SDK integrates and abstracts the discovery and connectivity between all supported protocols.
3
+
This project can be built in Android Studio or directly with Gradle. Eclipse IDE is not supported since 1.5.0 version.
3
4
4
5
For more information, visit our [website](http://www.connectsdk.com/).
5
6
@@ -12,25 +13,32 @@ This project has the following dependencies, some of which require manual setup.
9. Right-click the `Connect-SDK-Android-Core` project and select `Properties`, in the `Library` pane of the `Android` tab add
65
-
- Connect-SDK-Android
66
-
10. Right-click the `Connect-SDK-Android-Google-Cast` project and select `Properties`, in the `Library` pane of the `Android` tab add following libraries
67
-
- Connect-SDK-Android-Core
68
-
- android-support-v7-appcompat
69
-
- android-support-v7-mediarouter
70
-
- google-play-services_lib
71
-
11. **IN YOUR PROJECT** select `Properties`, in the `Library` pane of the `Android` tab add following libraries
72
-
- Connect-SDK-Android-Core
73
-
- Connect-SDK-Android-Google-Cast
74
-
12. Set up your manifest file as per the instructions below
@@ -112,49 +96,44 @@ Add the following line to your proguard configuration file (otherwise `Discovery
112
96
-keep class com.connectsdk.** { * ; }
113
97
```
114
98
115
-
##Migrating from 1.3 to 1.4 release
116
-
117
-
1. Open terminal and go to your local Connect-SDK-Android repo
118
-
2. Pull the latest updates by running command `git pull` in Terminal
119
-
3. Set up the submodules by running the following commands in Terminal
120
-
-`git submodule init`
121
-
-`git submodule update`
122
-
4. Open Eclipse
123
-
5. Click `File > Import`
124
-
6. Select `Existing Android Code Into Workspace` and click `Next`
125
-
7. Browse to the `Connect-SDK-Android/core` folder and click `Open` to import core submodule
126
-
8. Click `Finish`
127
-
9. Do the steps 5-8 for Connect-SDK-Android-Google-Cast which is located in `Connect-SDK-Android/modules/google_cast` folder
128
-
10. Right click on `Connect-SDK-Android` project and select `Properties`, in the `Library` pane of the `Android` tab
129
-
- remove all libraries references
130
-
11. Right-click the `Connect-SDK-Android-Core` project and select `Properties`, in the `Library` pane of the `Android` tab add
131
-
- Connect-SDK-Android
132
-
12. Right-click the `Connect-SDK-Android-Google-Cast` project and select `Properties`, in the `Library` pane of the `Android` tab add following libraries
133
-
- Connect-SDK-Android-Core
134
-
- android-support-v7-appcompat
135
-
- android-support-v7-mediarouter
136
-
- google-play-services_lib
137
-
13.**IN YOUR PROJECT** select `Properties`, in the Library pane of the Android tab
138
-
- remove Connect-SDK-Android
139
-
- add Connect-SDK-Android-Core
140
-
- add Connect-SDK-Android-Google-Cast.
99
+
###Tests
100
+
Connect SDK has unit tests for some parts of the code, and we are continuing to increase the test coverage.
101
+
These tests are based on third party libraries such as Robolectric, Mockito and PowerMock. You can easily run these tests with Gradle:
102
+
```
103
+
gradle test
104
+
```
105
+
Also the project has a target for generating test coverage report with Jacoco. Use this command for generating it.
106
+
```
107
+
gradle jacocoTestReport
108
+
```
109
+
The test coverage report will be in this folder `Connect-SDK-Android/build/reports/jacoco/jacocoTestReport/html`.
* Ask a question with the "tv" tag on [Stack Overflow](http://stackoverflow.com/tags/tv)
113
+
* Ask a question on Stack Overflow with the [Connect-SDK tag](https://stackoverflow.com/tags/connect-sdk) (or [TV tag](https://stackoverflow.com/tags/tv))
0 commit comments