Skip to content

Commit 509277e

Browse files
authored
Add contributing guidelines to CONTRIBUTING.md
Added guidelines for contributing to the project, including setup instructions for Firebase Emulator Suite and mobile app development.
1 parent 9351b5e commit 509277e

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# How to contribute
2+
3+
TwoAxis Finance is built entirely on Firebase, and the mobile client is built using Flutter.
4+
5+
## Running the Firebase Emulator Suite
6+
In order to contribute, you must use the Firebase Emulator Suite.
7+
8+
- Make sure that you have Firebase Tools CLI installed: `npm install -g firebase-tools`
9+
- Run Firebase emulators locally: `firebase emulators:start`
10+
11+
## Running the mobile app
12+
- Open the `mobile/` directory in Android Studio (or IDE that supports Flutter).
13+
- Run `main.dart` in development mode (`assembleDebug`)
14+
15+
Note: The mobile client connects to the Firebase Emulators in debug mode only (`kDebugMode`). You may change this in `lib/main.dart`, but do not commit your changes.
16+
17+
## Pull Requests
18+
Your pull requests will be reviewed throughly, please submit many small pull requests rather than one big one.
19+
Make sure to assign proper labels to your pull request as it will impact the review.
20+
Include a description with your pull request that includes an overview of what the pull request changes.

0 commit comments

Comments
 (0)