|
@@ -1,4 +1,5 @@
|
1
|
|
-# Folder Structure
|
|
1
|
+# Contributing
|
|
2
|
+## Folder Structure
|
2
|
3
|
|
3
|
4
|
| Folder | Description |
|
4
|
5
|
| ------ | ----------- |
|
|
@@ -13,7 +14,7 @@
|
13
|
14
|
| `integration` | misc javascript integration tests |
|
14
|
15
|
| `scripts` | all scripts |
|
15
|
16
|
|
16
|
|
-# Running locally
|
|
17
|
+## Running locally
|
17
|
18
|
|
18
|
19
|
### Environment requirements
|
19
|
20
|
|
|
@@ -73,3 +74,13 @@ brew tap facebook/fb && brew install fbsimctl
|
73
|
74
|
| `yarn test-e2e-ios` | runs the ios e2e suite (with detox) in debug/release |
|
74
|
75
|
| `yarn test-e2e-android` | runs the android e2e suite (with uiautomator) in debug/release on running devices/emulators <br> **Options:** `-- release` |
|
75
|
76
|
| `yarn test-all` | runs all tests in parallel |
|
|
77
|
+
|
|
78
|
+## Workflow
|
|
79
|
+This project is driven by tests. Before implementing any feature or fixing any bug, a failing test (e2e or unit or both) should be added, depending on the environment of where the fix should be implemented. For example, for an API change, a failing e2e should be written. For a small bug fix in Android, for example, a unit test in Android should be added.
|
|
80
|
+
|
|
81
|
+This will ensure good quality throughout the life of the project and will avoid unexpected breakages.
|
|
82
|
+
|
|
83
|
+No PR will be accepted without adequate test coverage.
|
|
84
|
+
|
|
85
|
+To run the tests, use the scripts above.
|
|
86
|
+
|