Skip to content

Commit 1ad0d26

Browse files
laurenzlonglaurenzlong
authored
Add license, readme and Github template docs (#2)
1 parent 9285e0f commit 1ad0d26

File tree

5 files changed

+151
-1
lines changed

5 files changed

+151
-1
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,24 @@
1+
# How to contribute
12

3+
We'd love to accept your patches and contributions to this project. There are
4+
just a few small guidelines you need to follow.
5+
6+
## Contributor License Agreement
7+
8+
Contributions to this project must be accompanied by a Contributor License
9+
Agreement. You (or your employer) retain the copyright to your contribution,
10+
this simply gives us permission to use and redistribute your contributions as
11+
part of the project. Head over to <https://cla.developers.google.com/> to see
12+
your current agreements on file or to sign a new one.
13+
14+
You generally only need to submit a CLA once, so if you've already submitted one
15+
(even if it was for a different project), you probably don't need to do it
16+
again.
17+
18+
## Code reviews
19+
20+
All submissions, including submissions by project members, require review. We
21+
use GitHub pull requests for this purpose. Consult [GitHub Help] for more
22+
information on using pull requests.
23+
24+
[GitHub Help]: https://help.github.com/articles/about-pull-requests/

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<!--
2+
3+
Thank you for contributing to the Firebase community!
4+
5+
Have a usage question?
6+
=======================
7+
We get lots of those and we love helping you, but GitHub is not the best place for them and they
8+
will be closed. Here are some resources to get help:
9+
10+
- Go through the guide: https://firebase.google.com/docs/functions/unit-testing
11+
- See examples of how this library is used: https://github.com/firebase/functions-samples/blob/master/quickstarts/uppercase/functions/test
12+
13+
If the official documentation doesn't help, try asking through our official support channels:
14+
15+
https://firebase.google.com/support/
16+
17+
*Please avoid double posting across multiple channels!*
18+
19+
Think you found a bug?
20+
=======================
21+
Yeah, we're definitely not perfect! Please use the bug report template below and include a minimal
22+
repro when opening the issue.
23+
24+
25+
Have a feature request?
26+
========================
27+
Great, we love hearing how we can improve our products! Please submit your feature requests to:
28+
https://firebase.google.com/support/contact/bugs-features/. Select 'Functions' as the 'component'.
29+
30+
-->
31+
32+
### Version info
33+
34+
<!-- What versions of the following libraries are you using? Note that your issue may already
35+
be fixed in the latest versions. -->
36+
37+
**firebase-functions-test:**
38+
39+
**firebase-functions:**
40+
41+
**firebase-admin:**
42+
43+
### Test case
44+
45+
<!-- Provide a minimal, complete, and verifiable example (http://stackoverflow.com/help/mcve) -->
46+
47+
48+
### Steps to reproduce
49+
50+
<!-- Provide the steps needed to reproduce the issue given the above test case. -->
51+
52+
53+
### Expected behavior
54+
55+
<!-- What is the expected behavior? -->
56+
57+
58+
### Actual behavior
59+
60+
<!-- Please copy and paste any command line output -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!--
2+
3+
Thank you for contributing to the Firebase community! Please fill out the pull request form below
4+
and make note of the following:
5+
6+
Run the linter and test suite
7+
==============================
8+
Run `npm test` to make sure your changes compile properly and the tests all pass on your local machine.
9+
We've hooked up this repo with continuous integration to double check those things for you.
10+
11+
Add tests (if applicable)
12+
==============================
13+
Most non-trivial changes should include some extra test coverage. If you aren't sure how to add
14+
tests, feel free to submit regardless and ask us for some advice.
15+
16+
Sign our CLA
17+
==============================
18+
Please sign our Contributor License Agreement (https://cla.developers.google.com/about/google-individual)
19+
before sending PRs. We cannot accept code without this.
20+
21+
-->
22+
23+
### Description
24+
25+
<!-- Are you fixing a bug? Implementing a new feature? Make sure we have the context around your change.
26+
Link to other relevant issues or pull requests. -->
27+
28+
### Code sample
29+
30+
<!-- Proposing an API change? Provide code samples showing how the API will be used. -->

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 Firebase
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,17 @@
1-
# firebase-functions-fake
1+
# Firebase Test SDK for Cloud Functions
2+
3+
The `firebase-functions-test` is unit testing library for Cloud Functions for Firebase. It is a companion to [firebase-functions](https://github.com/Firebase/firebase-functions).
4+
5+
_NOTE: This library can only be used with `firebase-functions` v1.0.0 or above._
6+
7+
## Learn more
8+
9+
Learn more about the SDK [Firebase documentation](https://firebase.google.com/docs/functions/unit-testing) or [check out sample unit tests](https://github.com/firebase/functions-samples/blob/master/quickstarts/uppercase/functions).
10+
11+
## Contributing
12+
13+
To contribute a change, [check out the contributing guide](.github/CONTRIBUTING.md).
14+
15+
## License
16+
17+
© Google, 2018. Licensed under [The MIT License](LICENSE).

0 commit comments

Comments
 (0)