Skip to content

Commit 0c497f8

Browse files
SelaseKayrussellwheatleyjude.kwashie
authored
docs: update CONTRIBUTING.md for e2e tests (#400)
Co-authored-by: russellwheatley <[email protected]> Co-authored-by: jude.kwashie <[email protected]>
1 parent da82f31 commit 0c497f8

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

Diff for: CONTRIBUTING.md

+20
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,26 @@ guide. For example, for a fix to the `firebase_ui_auth` plugin:
128128
Plugins tests are run automatically on contributions using GitHub Actions. Depending on
129129
your code contributions, various tests will be run against your updated code automatically.
130130

131+
### End-to-end (e2e) tests
132+
133+
E2e tests are those which directly communicate with Firebase, whose results cannot be mocked.
134+
These tests require the Firebase Emulator.
135+
136+
To start the Firebase Emulator, run this command:
137+
138+
```bash
139+
firebase emulator:start
140+
```
141+
142+
Once the Firebase Emulator is up and running, execute the following Melos command from the terminal:
143+
144+
```bash
145+
melos test:e2e
146+
```
147+
148+
Before submitting your PR, please provide evidence of running the E2E tests on macOS, Android, and iOS by sharing terminal output or screenshots. This demonstrates that the few E2E tests skipped in CI run successfully locally, which will enhance the review process for your PR.
149+
150+
131151
Once you've gotten an LGTM from a project maintainer and once your PR has received
132152
the green light from all our automated testing, wait for one the package maintainers
133153
to merge the pull request.

0 commit comments

Comments
 (0)