From f4bd486ad944473dafc9f3e566e4a6ec1fe439ae Mon Sep 17 00:00:00 2001 From: insleker Date: Wed, 3 Sep 2025 17:03:16 +0800 Subject: [PATCH] doces: add AGENTS.md for better hinting LLM --- AGENTS.md | 12 ++++++++++++ README.md | 11 +++++++---- docs/meta-arch.md | 2 ++ 3 files changed, 21 insertions(+), 4 deletions(-) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..a7e41e9 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,12 @@ +# AGENTS + +Always read `README.md` and `docs/meta-arch.md` when new chat created. + +Additionally read relevant files depends on task. + +* If want to modify use cases (files at `test/features/*.feature`) + * read `docs/FRs.md` +* If want to modify code (implement or test) of `View` of MVVM (UI widget) (files at `lib/ui/features/*/widgets/*`) + * read `docs/wireframe.md`, `docs/NFRs.md`, `test/features/*.feature` +* If want to modify code (implement or test) of non-View e.g. `Model`, `View Model`, services... + * read `test/features/*.feature`, `docs/NFRs.md` diff --git a/README.md b/README.md index b2b9663..19bbc24 100644 --- a/README.md +++ b/README.md @@ -12,17 +12,20 @@ checkout [`docs/FRs.md`](docs/FRs.md) # flutter clean # arb_translate flutter pub get -# generate gherkin test +# > to generate gherkin test flutter pub run build_runner build --delete-conflicting-outputs +# > to remove unused step definitions # dart run tool/prune_unused_steps.dart --delete +# > to static analyze the code +flutter analyze +# > run unit tests and widget tests +flutter test + # dart run tool/gen_view_wireframe_md.dart # flutter pub run dead_code_analyzer # run the app flutter run - -# run unit tests and widget tests -flutter test ``` ### build diff --git a/docs/meta-arch.md b/docs/meta-arch.md index 6db0118..1dd7752 100644 --- a/docs/meta-arch.md +++ b/docs/meta-arch.md @@ -20,3 +20,5 @@ The repo structure follows official [Package structure](https://docs.flutter.dev * [How to zoom in PdfPageView #244](https://github.com/espresso3389/pdfrx/issues/244) * So does overlay some widgets, they should be placed using the provided overlay builder. * [Viewer Customization using Widget Overlay](https://pub.dev/documentation/pdfrx/latest/pdfrx/PdfViewerParams/viewerOverlayBuilder.html) + * [Per-page Customization using Widget Overlay](https://pub.dev/documentation/pdfrx/latest/pdfrx/PdfViewerParams/pageOverlaysBuilder.html) + * `pageOverlaysBuilder`