This repository has been archived by the owner on Jan 22, 2020. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Convert Cannonball to be used for Google Development
Use Podfile instead of Frameworks Update to Swift 4 Update XCode-generated files Remove Mopub Add .gitignore Update licence year, readme, and Contributing
- Loading branch information
Showing
387 changed files
with
893 additions
and
14,087 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,41 @@ | |||
# GOOGLE SAMPLE PACKAGING DATA | |||
# | |||
# This file is used by Google as part of our samples packaging process. | |||
# End users may safely ignore this file. It has no relevance to other systems. | |||
--- | |||
# Values: {DRAFT | PUBLISHED | INTERNAL | DEPRECATED | SUPERCEDED} | |||
status: PUBLISHED | |||
|
|||
# Optional, put additional explanation here for DEPRECATED or SUPERCEDED. | |||
# statusNote: | |||
|
|||
# See http://go/sample-categories | |||
technologies: [Android, AppEngine, Google+] | |||
categories: [Getting Started, UI] | |||
languages: [Java, Python] | |||
solutions: [Mobile] | |||
|
|||
# May be omitted if unpublished | |||
github: google/actionbar-basics | |||
|
|||
# Values: BEGINNER | INTERMEDIATE | ADVANCED | EXPERT | |||
level: BEGINNER | |||
|
|||
# Dimensions: 512x512, PNG fomrat | |||
icon: screenshots/icon.png | |||
|
|||
# List of APIs that this sample should be listed under. Use authoritive, | |||
# names that are unique for the product in question. Examples: | |||
# | |||
# Android - android:<class-name> | |||
# App Engine - gae-java:<class name> | |||
# gae-python:<package> | |||
# Web Services - ws:<name of API from Cloud Console> | |||
apiRefs: | |||
- android:com.android.ui.ActionBar | |||
- ws:drive.files | |||
- ws:urlshortener.url | |||
|
|||
# Default: apache2. May be omitted for most samples. | |||
# Alternatives: apache2-android (for AOSP) | |||
license: apache2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -1,67 +1,190 @@ | |||
# Contributing to Cannonball | # Contributing to Cannonball | ||
|
|
||
Looking to contribute something to the hbc? Here's how you can help. | We'd love for you to contribute to our source code and to make Cannonball even better than it is today! Here are the guidelines we'd like you to follow: | ||
|
|
||
## Bugs reports | - [Code of Conduct](#coc) | ||
- [Question or Problem?](#question) | |||
- [Issues and Bugs](#issue) | |||
- [Feature Requests](#feature) | |||
- [Submission Guidelines](#submit) | |||
- [Coding Rules](#rules) | |||
- [Signing the CLA](#cla) | |||
|
|
||
A bug is a _demonstrable problem_ that is caused by the code in the | ## <a name="coc"></a> Code of Conduct | ||
repository. Good bug reports are extremely helpful - thank you! | |||
|
|
||
Guidelines for bug reports: | As contributors and maintainers of the Cannonball project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities. | ||
|
|
||
1. **Use the GitHub issue search** — check if the issue has already been | Communication through any of Cannonball or Firebase's channels (GitHub, StackOverflow, Google+, Twitter, etc.) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. | ||
reported. | |||
|
|
||
2. **Check if the issue has been fixed** — try to reproduce it using the | We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the project to do the same. | ||
latest `master` or development branch in the repository. | |||
|
|
||
3. **Isolate the problem** — ideally create a reduced test | If any member of the community violates this code of conduct, the maintainers of the Cannonball project may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate. | ||
case and a live example. | |||
|
|
||
4. Please try to be as detailed as possible in your report. Include specific | If you are subject to or witness unacceptable behavior, or have any other concerns, please drop us a line at mbonnell@google.com. | ||
information about the environment - operating system and version, browser | |||
and version, version of hbc - and steps required to reproduce the issue. | |||
|
|
||
## Feature requests & contribution enquiries | ## <a name="question"></a> Got a Question or Problem? | ||
|
|
||
Feature requests are welcome. But take a moment to find out whether your idea | If you have technical questions about Friendly Pix, please direct these to [StackOverflow][stackoverflow] and use the `firebase` tag. We are also available on GitHub issues. | ||
fits with the scope and aims of the project. It's up to *you* to make a strong | |||
case for the inclusion of your feature. Please provide as much detail and | |||
context as possible. | |||
|
|
||
Contribution enquiries should take place before any significant pull request, | ## <a name="issue"></a> Found an Issue? | ||
otherwise you risk spending a lot of time working on something that we might | If you find a bug in the source code or a mistake in the documentation, you can help us by | ||
have good reasons for rejecting. | submitting an issue to our [GitHub Repository][github]. Even better you can submit a Pull Request | ||
with a fix. | |||
|
|
||
## Pull requests | See [below](#submit) for some guidelines. | ||
|
|
||
Good pull requests - patches, improvements, new features - are a fantastic | ## <a name="feature"></a> Want a Feature? | ||
help. They should remain focused in scope and avoid containing unrelated | You can request a new feature by submitting an issue to our [GitHub Repository][github]. | ||
commits. | |||
|
|
||
Make sure to adhere to the coding conventions used throughout the codebase | If you would like to implement a new feature then consider what kind of change it is: | ||
(indentation, accurate comments, etc.) and any other requirements (such as test |
|
||
coverage). | * **Major Changes** that you wish to contribute to the project should be discussed first on our | ||
[issue tracker][github] so that we can better coordinate our efforts, prevent | |||
duplication of work, and help you to craft the change so that it is successfully accepted into the | |||
project. | |||
* **Small Changes** can be crafted and submitted to the [GitHub Repository][github] as a Pull Request directly. | |||
|
|||
## <a name="submit"></a> Submission Guidelines | |||
### Submitting an Issue | |||
Before you submit your issue, search the archive - maybe your question was already answered. | |||
|
|||
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. Providing the following information will increase the | |||
chances of your issue being dealt with quickly: | |||
|
|||
* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps | |||
* **Motivation for or Use Case** - explain why this is a bug for you | |||
* **Friendly Pix Version(s)** - is it a regression? | |||
* **Browsers and Operating System** - is this a problem with all browsers or only some browsers? | |||
* **Reproduce the Error** - provide an unambiguous set of steps. | |||
* **Related Issues** - has a similar issue been reported before? | |||
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit) | |||
|
|||
**If you get help, help others. Good karma rulez!** | |||
|
|||
Here's a template to get you started: | |||
|
|||
``` | |||
Browser: | |||
Browser version: | |||
Operating system: | |||
Operating system version: | |||
URL, if applicable: | |||
What steps will reproduce the problem: | |||
1. | |||
2. | |||
3. | |||
What is the expected result? | |||
What happens instead of that? | |||
Please provide any other information below, and attach a screenshot if possible. | |||
``` | |||
|
|||
### Submitting a Pull Request | |||
|
|||
Before you submit your pull request consider the following guidelines: | |||
|
|||
* Search [GitHub](https://github.com/firebase/cannonball-ios/pulls) for an open or closed Pull Request | |||
that relates to your submission. You don't want to duplicate effort. | |||
* Please sign our [Contributor License Agreement (CLA)](#cla) before sending pull | |||
requests. We cannot accept code without this. | |||
* Make your changes in a new git branch: | |||
|
|||
```shell | |||
git checkout -b my-fix-branch master | |||
``` | |||
* Create your patch, **including appropriate test cases**. | |||
* Follow our [Coding Rules](#rules). | |||
* Avoid checking in files that shouldn't be tracked (e.g `Pods`, `*.xcworkspace`, `build`, `.idea`). We recommend using a [global](#global-gitignore) gitignore for this. | |||
* Make sure **not** to include a recompiled version of the files as part of your PR. We will generate these automatically. | |||
* Commit your changes using a descriptive commit message. | |||
|
|||
```shell | |||
git commit -a | |||
``` | |||
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. | |||
|
|
||
Please follow this process; it's the best way to get your work included in the | * Build your changes locally to ensure all the tests pass: | ||
project: | |||
|
|
||
1. Create a new topic branch to contain your feature, change, or fix: | ```shell | ||
gulp | |||
``` | |||
|
|
||
2. Commit your changes in logical chunks. Provide clear and explanatory commit | * Push your branch to GitHub: | ||
messages. Use git's [interactive rebase](https://help.github.com/articles/interactive-rebase) | |||
feature to tidy up your commits before making them public. | |||
|
|
||
3. Locally merge (or rebase) the upstream development branch into your topic branch: | ```shell | ||
git push origin my-fix-branch | |||
``` | |||
* In GitHub, send a pull request to `cannonball-ios:master`. | |||
* If we suggest changes then: | |||
* Make the required updates. | |||
* Re-run the Friendly Pix test suite to ensure tests are still passing. | |||
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request): | |||
|
|
||
4. Push your topic branch up to your fork: | ```shell | ||
git rebase master -i | |||
git push origin my-fix-branch -f | |||
``` | |||
|
|
||
5. [Open a Pull Request](http://help.github.com/send-pull-requests/) with a | That's it! Thank you for your contribution! | ||
clear title and description. |
|
||
#### After your pull request is merged | |||
|
|||
After your pull request is merged, you can safely delete your branch and pull the changes | |||
from the main (upstream) repository: | |||
|
|||
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: | |||
|
|||
```shell | |||
git push origin --delete my-fix-branch | |||
``` | |||
|
|||
* Check out the master branch: | |||
|
|||
```shell | |||
git checkout master -f | |||
``` | |||
|
|||
* Delete the local branch: | |||
|
|||
```shell | |||
git branch -D my-fix-branch | |||
``` | |||
|
|||
* Update your master with the latest upstream version: | |||
|
|||
```shell | |||
git pull --ff upstream master | |||
``` | |||
|
|||
## <a name="rules"></a> Coding Rules | |||
|
|||
Make sure to adhere to the coding conventions used throughout the codebase | |||
(indentation, accurate comments, etc.) and any other requirements. | |||
|
|||
## <a name="cla"></a> Signing the CLA | |||
|
|||
Contributions to this project must be accompanied by a Contributor License | |||
Agreement. You (or your employer) retain the copyright to your contribution; | |||
this simply gives us permission to use and redistribute your contributions as | |||
part of the project. Head over to <https://cla.developers.google.com/> to see | |||
your current agreements on file or to sign a new one. | |||
|
|||
You generally only need to submit a CLA once, so if you've already submitted one | |||
(even if it was for a different project), you probably don't need to do it | |||
again. | |||
|
|
||
## License | ## License | ||
|
|
||
By contributing your code, | By contributing your code, You agree to license your contribution under the terms of the Apache Public License 2.0 | ||
https://github.com/firebase/cannonball-ios/blob/master/LICENSE | |||
|
|||
[github]: https://github.com/firebase/cannonball-ios | |||
[google-cla]: https://cla.developers.google.com | |||
[stackoverflow]: http://stackoverflow.com/questions/tagged/firebase | |||
[global-gitignore]: https://help.github.com/articles/ignoring-files/#create-a-global-gitignore | |||
|
|
||
You agree to license your contribution under the terms of the Apache Public License 2.0 | |||
https://github.com/crashlytics/cannonball-ios/blob/master/LICENSE |
Oops, something went wrong.