@@ -50,6 +50,12 @@ Sweet, we'd love to accept your contribution!
50
50
[ Open a new pull request] ( https://github.com/firebase/firebase-admin-go/pull/new/master ) and fill
51
51
out the provided template.
52
52
53
+ Make sure to create all your pull requests against the ` dev ` branch. All development
54
+ work takes place on this branch, while the ` master ` branch is dedicated for released
55
+ stable code. This enables us to review and merge routine code changes, without
56
+ impacting downstream applications that are building against our ` master `
57
+ branch.
58
+
53
59
** If you want to implement a new feature, please open an issue with a proposal first so that we can
54
60
figure out if the feature makes sense and how it will work.**
55
61
@@ -87,7 +93,7 @@ information on using pull requests.
87
93
Use the standard GitHub and [ Go development tools] ( https://golang.org/doc/cmd )
88
94
to build and test the Firebase Admin SDK. Follow the instructions given in
89
95
the [ golang documentation] ( https://golang.org/doc/code.html ) to get your
90
- ` GOPATH ` configured correctly. Then execute the following series of commands
96
+ ` GOPATH ` set up correctly. Then execute the following series of commands
91
97
to checkout the sources of Firebase Admin SDK, and its dependencies:
92
98
93
99
``` bash
@@ -104,7 +110,7 @@ Invoke the `go test` command as follows to build and run the unit tests:
104
110
go test -test.short firebase.google.com/go/...
105
111
```
106
112
107
- Note the ` -test.short ` flag passed into the ` go test ` command. This will skip
113
+ Note the ` -test.short ` flag passed to the ` go test ` command. This will skip
108
114
the integration tests, and only execute the unit tests.
109
115
110
116
### Integration Testing
@@ -117,15 +123,17 @@ following credentials from the project:
117
123
118
124
1 . * Service account certificate* : This can be downloaded as a JSON file from
119
125
the "Settings > Service Accounts" tab of the Firebase console. Copy the
120
- file into your workspace as
126
+ file into your Go workspace as
121
127
` src/firebase.google.com/go/testdata/integration_cert.json ` .
122
128
2 . * Web API key* : This is displayed in the "Settings > General" tab of the
123
129
console. Copy it and save to a new text file. Copy this text file into
124
- your workspace as
130
+ your Go workspace as
125
131
` src/firebase.google.com/go/testdata/integration_apikey.txt ` .
126
132
127
- Now you can invoke the integration test suite as follows:
133
+ Now you can invoke the test suite as follows:
128
134
129
- ```
135
+ ``` bash
130
136
go test firebase.google.com/go/...
131
137
```
138
+
139
+ This will execute both unit and integration test suites.
0 commit comments