Add a basic HACKING.md

Signed-off-by: Harsh Shandilya <me@msfjarvis.dev>
This commit is contained in:
Harsh Shandilya 2021-03-11 16:57:31 +05:30
parent a5a710cbb1
commit ae1770e4ac
No known key found for this signature in database
GPG key ID: 366D7BBAD1031E80

7
HACKING.md Normal file
View file

@ -0,0 +1,7 @@
# Hacking on compose-lobsters
This app is built as a very lightweight frontend for [lobste.rs](https://lobste.rs), mainly as an experiment in using [Jetpack Compose](https://d.android.com/jetpack/compose).
The codebase is fairly simple, and the package structure follows [Buffer's](https://buffer.com/resources/android-rethinking-package-structure/).
We use screenshot testing for our UI, and a script is included in the `scripts` directory to create an emulator that will exactly match the one in our CI so you can deterministically replicate the setup for locally running tests.