Merge pull request #159 from zcash/task/final-preparations
Contributing guide and helper file for easier builds.
This commit is contained in:
commit
762eff533b
|
@ -49,7 +49,9 @@ captures/
|
||||||
.externalNativeBuild
|
.externalNativeBuild
|
||||||
|
|
||||||
# Google Services (e.g. APIs or Firebase)
|
# Google Services (e.g. APIs or Firebase)
|
||||||
google-services.json
|
|
||||||
|
# allow our dummy file to live in the repo to make building easier
|
||||||
|
#google-services.json
|
||||||
|
|
||||||
# Freeline
|
# Freeline
|
||||||
freeline.py
|
freeline.py
|
||||||
|
|
|
@ -0,0 +1,98 @@
|
||||||
|
# Contributing Guidelines
|
||||||
|
|
||||||
|
This document contains information and guidelines about contributing to this project.
|
||||||
|
Please read it before you start participating.
|
||||||
|
|
||||||
|
**Topics**
|
||||||
|
|
||||||
|
* [Asking Questions](#asking-questions)
|
||||||
|
* [Reporting Security Issues](#reporting-security-issues)
|
||||||
|
* [Reporting Non Security Issues](#reporting-other-issues)
|
||||||
|
* [Developers Certificate of Origin](#developers-certificate-of-origin)
|
||||||
|
|
||||||
|
## Asking Questions
|
||||||
|
|
||||||
|
Questions are welcome! We encourage you to ask questions through GitHub issues.
|
||||||
|
Before doing so, please check that the project issues database doesn't already
|
||||||
|
include an answer to your question. Then open a new Issue and use the "Question"
|
||||||
|
label.
|
||||||
|
|
||||||
|
## Reporting Security Issues
|
||||||
|
|
||||||
|
If you have discovered an issue with this code that could present a security hazard or wish to discuss a sensitive issue with our security team, please contact security@z.cash [security.asc](https://z.cash/gpg-pubkeys/security.asc). Key fingerprint = AF85 0445 546C 18B7 86F9 2C62 88FB 8B86 D8B5 A68C
|
||||||
|
|
||||||
|
## Reporting Non Security Issues
|
||||||
|
|
||||||
|
A great way to contribute to the project
|
||||||
|
is to send a detailed issue when you encounter a problem.
|
||||||
|
We always appreciate a well-written, thorough bug report.
|
||||||
|
|
||||||
|
Check that the project issues database
|
||||||
|
doesn't already include that problem or suggestion before submitting an issue.
|
||||||
|
If you find a match, add a quick "+1" or "I have this problem too."
|
||||||
|
Doing this helps prioritize the most common problems and requests.
|
||||||
|
|
||||||
|
When reporting issues, please include the following:
|
||||||
|
|
||||||
|
* The Android API you're using
|
||||||
|
* The device you're targeting
|
||||||
|
* The full output of any stack trace or compiler error
|
||||||
|
* A code snippet that reproduces the described behavior, if applicable
|
||||||
|
* Any other details that would be useful in understanding the problem
|
||||||
|
|
||||||
|
This information will help us review and fix your issue faster.
|
||||||
|
|
||||||
|
## Pull Requests
|
||||||
|
|
||||||
|
We **love** pull requests!
|
||||||
|
|
||||||
|
All contributions _will_ be licensed under the MIT license.
|
||||||
|
|
||||||
|
Code/comments should adhere to the following rules:
|
||||||
|
|
||||||
|
* Every Pull request must have an Issue associated to it. PRs with not
|
||||||
|
associated with an Issue will be closed
|
||||||
|
* Code build and Code Lint must pass.
|
||||||
|
* Names should be descriptive and concise.
|
||||||
|
* Although they are not mandatory, PRs that include significant testing will be
|
||||||
|
prioritized.
|
||||||
|
* All enhancements and bug fixes need to be documented in the CHANGELOG.
|
||||||
|
* When writing comments, use properly constructed sentences, including
|
||||||
|
punctuation.
|
||||||
|
* When documenting APIs and/or source code, don't make assumptions or make
|
||||||
|
implications about race, gender, religion, political orientation or anything
|
||||||
|
else that isn't relevant to the project.
|
||||||
|
* Remember that source code usually gets written once and read often: ensure
|
||||||
|
the reader doesn't have to make guesses. Make sure that the purpose and inner
|
||||||
|
logic are either obvious to a reasonably skilled professional, or add a
|
||||||
|
comment that explains it.
|
||||||
|
|
||||||
|
## Developer's Certificate of Origin 1.1
|
||||||
|
|
||||||
|
By making a contribution to this project, I certify that:
|
||||||
|
|
||||||
|
- (a) The contribution was created in whole or in part by me and I
|
||||||
|
have the right to submit it under the open source license
|
||||||
|
indicated in the file; or
|
||||||
|
|
||||||
|
- (b) The contribution is based upon previous work that, to the best
|
||||||
|
of my knowledge, is covered under an appropriate open source
|
||||||
|
license and I have the right under that license to submit that
|
||||||
|
work with modifications, whether created in whole or in part
|
||||||
|
by me, under the same open source license (unless I am
|
||||||
|
permitted to submit under a different license), as indicated
|
||||||
|
in the file; or
|
||||||
|
|
||||||
|
- (c) The contribution was provided directly to me by some other
|
||||||
|
person who certified (a), (b) or (c) and I have not modified
|
||||||
|
it.
|
||||||
|
|
||||||
|
- (d) I understand and agree that this project and the contribution
|
||||||
|
are public and that a record of the contribution (including all
|
||||||
|
personal information I submit with it, including my sign-off) is
|
||||||
|
maintained indefinitely and may be redistributed consistent with
|
||||||
|
this project or the open source license(s) involved.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This contribution guide is inspired on great projects like [AlamoFire](https://github.com/Alamofire/Foundation/blob/master/CONTRIBUTING.md) and [CocoaPods](https://github.com/CocoaPods/CocoaPods/blob/master/CONTRIBUTING.md)
|
|
@ -0,0 +1,69 @@
|
||||||
|
{
|
||||||
|
"project_info": {
|
||||||
|
"project_number": "0",
|
||||||
|
"firebase_url": "https://a.b.com",
|
||||||
|
"project_id": "dummy",
|
||||||
|
"storage_bucket": "dummy"
|
||||||
|
},
|
||||||
|
"client": [
|
||||||
|
{
|
||||||
|
"client_info": {
|
||||||
|
"mobilesdk_app_id": "1:000000000000:android:8888888888888888888888",
|
||||||
|
"android_client_info": {
|
||||||
|
"package_name": "cash.z.ecc.android"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"oauth_client": [
|
||||||
|
{
|
||||||
|
"client_id": "dummy.apps.googleusercontent.com",
|
||||||
|
"client_type": 3
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"api_key": [
|
||||||
|
{
|
||||||
|
"current_key": "dummy"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"services": {
|
||||||
|
"appinvite_service": {
|
||||||
|
"other_platform_oauth_client": [
|
||||||
|
{
|
||||||
|
"client_id": "dummy.apps.googleusercontent.com",
|
||||||
|
"client_type": 3
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"client_info": {
|
||||||
|
"mobilesdk_app_id": "1:000000000000:android:8888888888888888888888",
|
||||||
|
"android_client_info": {
|
||||||
|
"package_name": "cash.z.ecc.android.testnet"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"oauth_client": [
|
||||||
|
{
|
||||||
|
"client_id": "dummy.apps.googleusercontent.com",
|
||||||
|
"client_type": 3
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"api_key": [
|
||||||
|
{
|
||||||
|
"current_key": "dummy"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"services": {
|
||||||
|
"appinvite_service": {
|
||||||
|
"other_platform_oauth_client": [
|
||||||
|
{
|
||||||
|
"client_id": "dummy.apps.googleusercontent.com",
|
||||||
|
"client_type": 3
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"configuration_version": "1"
|
||||||
|
}
|
Loading…
Reference in New Issue