docs: Add basic AI guidelines and documentation
This commit is contained in:
@@ -0,0 +1,42 @@
|
||||
# Linting And Test Flow
|
||||
|
||||
MoonWell Launcher supports the latest stable Flutter SDK only. Do not use FVM
|
||||
for this project.
|
||||
|
||||
## Required Checks
|
||||
|
||||
Run these commands before committing:
|
||||
|
||||
```powershell
|
||||
dart format --set-exit-if-changed .
|
||||
flutter analyze
|
||||
flutter test
|
||||
```
|
||||
|
||||
Use `dart format .` to apply formatting fixes when the format check fails.
|
||||
|
||||
## Lefthook
|
||||
|
||||
This repository includes `lefthook.yml` with a `pre-commit` hook that runs the
|
||||
same format, analyze, and test flow.
|
||||
|
||||
Install Lefthook once on your machine, then install the Git hook from the repo
|
||||
root:
|
||||
|
||||
```powershell
|
||||
lefthook install
|
||||
```
|
||||
|
||||
Run the pre-commit flow manually with:
|
||||
|
||||
```powershell
|
||||
lefthook run pre-commit
|
||||
```
|
||||
|
||||
If `lefthook` is not available, install it with your preferred package manager
|
||||
from the official Lefthook distribution, then rerun `lefthook install`.
|
||||
|
||||
## Windows Troubleshooting
|
||||
|
||||
If Flutter reports that building with plugins requires symlink support, enable
|
||||
Windows Developer Mode and rerun the command.
|
||||
Reference in New Issue
Block a user