bkinnightskytw
/
pdf_signature
mirror of https://github.com/existedinnettw/pdf_signature.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doces: add AGENTS.md for better hinting LLM

This commit is contained in:
insleker 2025-09-03 17:03:16 +08:00
parent 8e2599c0f8
commit f4bd486ad9
3 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
AGENTS.md Normal file
View File

@ -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`

11
README.md
View File

@ -12,17 +12,20 @@ checkout [`docs/FRs.md`](docs/FRs.md)
# flutter clean # flutter clean
# arb_translate # arb_translate
flutter pub get flutter pub get
# generate gherkin test # > to generate gherkin test
flutter pub run build_runner build --delete-conflicting-outputs flutter pub run build_runner build --delete-conflicting-outputs
# > to remove unused step definitions
# dart run tool/prune_unused_steps.dart --delete # 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 # dart run tool/gen_view_wireframe_md.dart
# flutter pub run dead_code_analyzer # flutter pub run dead_code_analyzer
# run the app # run the app
flutter run flutter run
# run unit tests and widget tests
flutter test
``` ```
### build ### build

2
docs/meta-arch.md
View File

@ -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) * [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. * 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) * [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`