Skip to content

Commit a1f8d5e

Browse files
committed
Merge branch 'master' into version-3.1.3-dev
Change-Id: I4ed551f5ad70e0c0b76c2297b9bf6c74191772bc
2 parents e102cc1 + e3ec786 commit a1f8d5e

13 files changed

+352
-194
lines changed

.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @samtstern @SUPERCILEX

.github/CODE_OF_CONDUCT.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/
File renamed without changes.
File renamed without changes.

PULL_REQUEST_TEMPLATE.md renamed to .github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ Hey there! So you want to contribute to FirebaseUI? Before you file this pull re
22

33
* Read [the contribution guidelines](CONTRIBUTING.md).
44
* Run `./gradlew check` to ensure the Travis build passes.
5-
* If this has been discussed in an issue, make sure to mention the issue number here. If not, go file an issue about this to make sure this is a desirable change.
5+
* If this has been discussed in an issue, make sure to mention the issue number here. If not, go file an issue about this to make sure this is a desirable change.
66
* If this is a new feature please co-ordinate with someone on [FirebaseUI-iOS](https://github.com/firebase/firebaseui-ios) to make sure that we can implement this on both platforms and maintain feature parity.

README.md

+53-44
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,31 @@ quickly connect common UI elements to [Firebase](https://firebase.google.com) AP
77

88
A compatible FirebaseUI client is also available for [iOS](https://github.com/firebase/firebaseui-ios).
99

10-
## Table of Contents
11-
12-
1. [Usage](#usage)
13-
1. [Installation](#installation)
14-
1. [Upgrading](#upgrading)
15-
1. [Dependencies](#dependencies)
16-
1. [Sample App](#sample-app)
17-
1. [Contributing](#contributing)
10+
## Table of contents
11+
12+
1. [Usage](#usage)
13+
1. [Installation](#installation)
14+
1. [Upgrading](#upgrading)
15+
1. [Dependencies](#dependencies)
16+
1. [Compatability](#compatibility-with-firebase--google-play-services-libraries)
17+
1. [Upgrading dependencies](#upgrading-dependencies)
18+
1. [Sample App](#sample-app)
19+
1. [Contributing](#contributing)
20+
1. [Installing](#installing-locally)
21+
1. [Deploying](#deployment)
22+
1. [Tagging](#tag-a-release-on-github)
23+
1. [License agreements](#contributor-license-agreements)
24+
1. [Process](#contribution-process)
1825

1926
## Usage
2027

2128
FirebaseUI has separate modules for using Firebase Realtime Database, Cloud Firestore,
2229
Firebase Auth, and Cloud Storage. To get started, see the individual instructions for each module:
2330

24-
* [firebase-ui-database](database/README.md)
25-
* [firebase-ui-firestore](firestore/README.md)
26-
* [firebase-ui-auth](auth/README.md)
27-
* [firebase-ui-storage](storage/README.md)
31+
* [FirebaseUI Auth](auth/README.md)
32+
* [FirebaseUI Firestore](firestore/README.md)
33+
* [FirebaseUI Database](database/README.md)
34+
* [FirebaseUI Storage](storage/README.md)
2835

2936
## Installation
3037

@@ -53,22 +60,21 @@ implementation 'com.firebaseui:firebase-ui-storage:3.1.2'
5360
```
5461

5562
If you're including the `firebase-ui-auth` dependency, there's a little
56-
[more setup](https://github.com/firebase/FirebaseUI-Android/tree/master/auth#configuration)
57-
required.
63+
[more setup](auth/README.md#configuration) required.
5864

5965
After the project is synchronized, we're ready to start using Firebase functionality in our app.
6066

61-
## Upgrading
67+
### Upgrading
6268

6369
If you are using an old version of FirebaseUI and upgrading, please see the appropriate
6470
migration guide:
6571

66-
* [Upgrade from 2.3.0 to 3.x.x](./docs/upgrade-to-3.0.md)
67-
* [Upgrade from 1.2.0 to 2.x.x](./docs/upgrade-to-2.0.md)
72+
* [Upgrade from 2.3.0 to 3.x.x](./docs/upgrade-to-3.0.md)
73+
* [Upgrade from 1.2.0 to 2.x.x](./docs/upgrade-to-2.0.md)
6874

6975
## Dependencies
7076

71-
### Compatibility with Firebase / Google Play Services Libraries
77+
### Compatibility with Firebase / Google Play Services libraries
7278

7379
FirebaseUI libraries have the following transitive dependencies on the Firebase SDK:
7480
```
@@ -87,7 +93,7 @@ firebase-ui-storage
8793
```
8894

8995
Each version of FirebaseUI has dependency on a fixed version of these libraries, defined as the variable `firebase_version`
90-
in `common/constants.gradle`. If you are using any dependencies in your app of the form
96+
in `common/constants.gradle`. If you are using any dependencies in your app of the form
9197
`implementation 'com.google.firebase:firebase-*:x.y.z'` or
9298
`implementation 'com.google.android.gms:play-services-*:x.y.z'`
9399
you need to make sure that you use the same version that your chosen version of FirebaseUI requires.
@@ -110,15 +116,15 @@ For convenience, here are some recent examples:
110116
| 1.0.0 | 9.8.0 |
111117

112118

113-
## Upgrading dependencies
119+
### Upgrading dependencies
114120

115121
If you would like to use a newer version of one of FirebaseUI's transitive dependencies, such
116122
as Firebase, Play services, or the Android support libraries, you need to add explicit
117123
`implementation` declarations in your `build.gradle` for all of FirebaseUI's dependencies at the version
118124
you want to use. For example if you want to use Play services/Firebase version `FOO` and support
119125
libraries version `BAR` add the following extra lines for each FirebaseUI module you're using:
120126

121-
Auth:
127+
#### Auth
122128

123129
```groovy
124130
implementation "com.google.firebase:firebase-auth:$FOO"
@@ -129,25 +135,25 @@ implementation "com.android.support:customtabs:$BAR"
129135
implementation "com.android.support:cardview-v7:$BAR"
130136
```
131137

132-
Realtime Database:
138+
#### Firestore
133139

134140
```groovy
135-
implementation "com.google.firebase:firebase-database:$FOO"
141+
implementation "com.google.firebase:firebase-firestore:$FOO"
136142
137143
implementation "com.android.support:recyclerview-v7:$BAR"
138144
implementation "com.android.support:support-v4:$BAR"
139145
```
140146

141-
Firestore:
147+
#### Realtime Database
142148

143149
```groovy
144-
implementation "com.google.firebase:firebase-firestore:$FOO"
150+
implementation "com.google.firebase:firebase-database:$FOO"
145151
146152
implementation "com.android.support:recyclerview-v7:$BAR"
147153
implementation "com.android.support:support-v4:$BAR"
148154
```
149155

150-
Storage:
156+
#### Storage
151157

152158
```groovy
153159
implementation "com.google.firebase:firebase-storage:$FOO"
@@ -156,7 +162,8 @@ implementation "com.android.support:appcompat-v7:$BAR"
156162
implementation "com.android.support:palette-v7:$BAR"
157163
```
158164

159-
NOTE :
165+
#### Note
166+
160167
Starting version 25.4.0, support libraries are now available through
161168
[Google's Maven repository](https://developer.android.com/studio/build/dependencies.html#google-maven),
162169
so ensure that you have that added to your project's repositories.
@@ -172,9 +179,9 @@ allprojects {
172179
}
173180
```
174181

175-
## Sample App
182+
## Sample app
176183

177-
There is a sample app in the `app/` directory that demonstrates most
184+
There is a sample app in the [`app/`](app) directory that demonstrates most
178185
of the features of FirebaseUI. Load the project in Android Studio and
179186
run it on your Android device to see a demonstration.
180187

@@ -197,17 +204,19 @@ Gradle to their latest versions.
197204
You can download FirebaseUI and install it locally by cloning this
198205
repository and running:
199206

200-
./gradlew :library:prepareArtifacts :library:publishAllToMavenLocal
207+
```sh
208+
./gradlew :library:prepareArtifacts :library:publishAllToMavenLocal
209+
```
201210

202211
### Deployment
203212

204213
To deploy FirebaseUI to Bintray
205214

206-
1. Set `BINTRAY_USER` and `BINTRAY_KEY` in your environment. You must
207-
be a member of the firebaseui Bintray organization.
208-
1. Run `./gradlew clean :library:prepareArtifacts :library:bintrayUploadAll`
209-
1. Go to the Bintray dashboard and click 'Publish'.
210-
1. In Bintray click the 'Maven Central' tab and publish the release.
215+
1. Set `BINTRAY_USER` and `BINTRAY_KEY` in your environment. You must
216+
be a member of the firebaseui Bintray organization.
217+
1. Run `./gradlew clean :library:prepareArtifacts :library:bintrayUploadAll`
218+
1. Go to the Bintray dashboard and click 'Publish'.
219+
1. In Bintray click the 'Maven Central' tab and publish the release.
211220

212221
### Tag a release on GitHub
213222

@@ -222,25 +231,25 @@ have to jump a couple of legal hurdles.
222231
Please fill out either the individual or corporate Contributor License Agreement
223232
(CLA).
224233

225-
* If you are an individual writing original source code and you're sure you
226-
own the intellectual property, then you'll need to sign an
227-
[individual CLA](https://developers.google.com/open-source/cla/individual).
228-
* If you work for a company that wants to allow you to contribute your work,
229-
then you'll need to sign a
230-
[corporate CLA](https://developers.google.com/open-source/cla/corporate).
234+
* If you are an individual writing original source code and you're sure you
235+
own the intellectual property, then you'll need to sign an
236+
[individual CLA](https://developers.google.com/open-source/cla/individual).
237+
* If you work for a company that wants to allow you to contribute your work,
238+
then you'll need to sign a
239+
[corporate CLA](https://developers.google.com/open-source/cla/corporate).
231240

232241
Follow either of the two links above to access the appropriate CLA and
233242
instructions for how to sign and return it. Once we receive it, we'll be able to
234243
accept your pull requests.
235244

236-
### Contribution Process
245+
### Contribution process
237246

238247
1. Submit an issue describing your proposed change to the repo in question.
239248
1. The repo owner will respond to your issue promptly.
240249
1. If your proposed change is accepted, and you haven't already done so, sign a
241250
Contributor License Agreement (see details above).
242-
1. Fork the desired repo, develop and test your code changes.
251+
1. Fork the desired repo, develop, and then test your code changes **on the latest dev branch**.
243252
1. Ensure that your code adheres to the existing style of the library to which
244253
you are contributing.
245254
1. Ensure that your code has an appropriate set of unit tests which all pass.
246-
1. Submit a pull request and cc @puf or @samtstern
255+
1. Submit a pull request targeting the latest dev branch.

0 commit comments

Comments
 (0)