Skip to content

Commit

Permalink
docs(app): update CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
tamslo committed Sep 20, 2024
1 parent 4b119d2 commit 9666d3f
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 9 deletions.
29 changes: 20 additions & 9 deletions app/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The structure of an example module `lib/my_module` should look as follows:
- `module.dart` (see example below):
- exports everything that is required by other modules, i.e., page(s) and
possibly the cubit
- declares all routes as functions reeturning `AutoRoute`
- declares all routes as functions returning `AutoRoute`
- may contain initialization code (`initMyModule()`)
- `widgets`:
- `my_widget.dart`: contains `MyWidget` and helpers
Expand Down Expand Up @@ -85,7 +85,7 @@ AutoRoute myModuleRoute({ required List<AutoRoute> children }) => AutoRoute(
page: MyModuleRootRoute.page,
children: [
AutoRoute(path: '', page: MyModuleRoute.page),
...children, // includes myChildRoute() and priva
...children, // includes myChildRoute()
],
);
```
Expand All @@ -107,14 +107,14 @@ _version (login without redirect) – can adopt once different login types are_
_supported._

Scripts were created to click through the app using tests and record the
screeen.
screen.

A simulator with the app in its initial state (or not installed) needs to be
running.

### Screencasts

The `generate_screendocs/generate_screencast.sh` script will create screencasts.
The `generate_screendocs/generate_screencast.sh` script will create screencast.
It uses Xcode to record the screencast and [`ffmpeg`](https://ffmpeg.org/)
to cut the `full.mov` to relevant subsets (needs to be installed).

Expand Down Expand Up @@ -154,13 +154,24 @@ shown below.

```dart
// TODO(after-testing): remove test data adaption
UserData.instance.diplotypes!['CYP2D6'] = Diplotype(
gene: 'CYP2D6',
resultType: 'Diplotype',
genotype: '*18/*143',
UserData.instance.labData = UserData.instance.labData!.filter(
(labResult) => labResult.gene != 'UGT1A1'
).toList();
UserData.instance.labData!.add(LabResult(
gene: 'UGT1A1',
variant: '*28/*28',
phenotype: 'Poor Metabolizer',
allelesTested: '',
);
));
UserData.instance.labData = UserData.instance.labData!.filter(
(labResult) => labResult.gene != 'HLA-B' && labResult.variant != '*57:01 negative'
).toList();
UserData.instance.labData!.add(LabResult(
gene: 'HLA-B',
variant: '*57:01 positive',
phenotype: '*57:01 positive',
allelesTested: '',
));
```

You can use the CPIC API to get reasonable genotype-phenotype pairings, e.g.,
Expand Down
6 changes: 6 additions & 0 deletions pharme.code-workspace
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
"loopable",
"lorcaserin",
"LTRB",
"maxdepth",
"MedlinePlus",
"Metabolizer",
"mirabegron",
Expand All @@ -87,10 +88,15 @@
"phenoconversion",
"Plattner",
"Proprinal",
"pubspec",
"RGBO",
"rxnorm",
"screencast",
"Screencasts",
"screendocs",
"sertraline",
"simvastatin",
"subfolders",
"tacrolimus",
"terbinafine",
"tramadol",
Expand Down

0 comments on commit 9666d3f

Please sign in to comment.