yorickr/plezy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify documentation: explain generated file exclusions

Browse Source 
Co-authored-by: Doezer <11655673+Doezer@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-11-13 22:07:01 +00:00
co-authored by Doezer
parent fd64f26c5e
commit ce5e5d7f94
2 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+5 -3
View File
@@ -10,7 +10,7 @@
## Development ## Development
- Follow Dart/Flutter conventions - Follow Dart/Flutter conventions
- Run `dart format .` to format your code - Run `dart format .` to format your code (note: generated files like `*.g.dart` are excluded from CI checks)
- Run `flutter analyze` before submitting to check for issues - Run `flutter analyze` before submitting to check for issues
- Run `flutter test` if tests are available - Run `flutter test` if tests are available
- Test your changes thoroughly - Test your changes thoroughly
@@ -20,11 +20,13 @@
The project includes automated CI checks that run on all pull requests: The project includes automated CI checks that run on all pull requests:
1. **Code Formatting**: Ensures code follows Dart formatting standards 1. **Code Formatting**: Ensures code follows Dart formatting standards
- Run locally: `dart format .` - Run locally: `dart format .` to format all files
- CI check excludes generated files (`.g.dart`, `.freezed.dart`) - Note: CI only checks non-generated files (excludes `.g.dart`, `.freezed.dart`)
- Generated files are reformatted automatically by build tools
2. **Static Analysis**: Checks for code issues and potential bugs 2. **Static Analysis**: Checks for code issues and potential bugs
- Run locally: `flutter analyze` - Run locally: `flutter analyze`
- Note: CI excludes generated files from analysis (configured in `analysis_options.yaml`)
3. **Tests**: Runs unit and widget tests (when available) 3. **Tests**: Runs unit and widget tests (when available)
- Run locally: `flutter test` - Run locally: `flutter test`
README.md
+3 -1
View File
@@ -82,7 +82,7 @@ flutter run
Before submitting changes, ensure your code passes all quality checks: Before submitting changes, ensure your code passes all quality checks:
```bash ```bash
# Format code # Format code (including generated files)
dart format . dart format .
# Analyze code for issues # Analyze code for issues
@@ -92,6 +92,8 @@ flutter analyze
flutter test flutter test
``` ```
**Note**: CI checks exclude generated files (`.g.dart`, `.freezed.dart`) from formatting and analysis checks. You can run `dart format .` locally to format everything, but only your hand-written code will be validated in CI.
These checks are automatically run in CI for all pull requests. These checks are automatically run in CI for all pull requests.
### Code Generation ### Code Generation