test: Setup jest tests (#4)

test: Add flutter repos for testing good and bad state
chore: Tidy directory structure
docs: Add more information to readme
test: Initialize Jest
test: Add tests for analyze, coverage and test
ci(automated commit): lint format and import sort

Co-authored-by: github-actions <[email protected]>

.gitignore

@@ -128,3 +128,39 @@ out
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+pubspec.lock
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.pub-cache/
+.pub/
+build/
+
+

README.md

@@ -1,27 +1,34 @@
 # flutter-code-quality
 
-An action that runs on PRs to format and test Flutter repos.
+This action is designed to format and test Flutter repositories on pull requests. It helps ensure that your code meets the required quality standards.
 
 ### Usage
 
+Follow the instructions below to integrate this action into your workflow.
+
 ```yml
 name: Pull Request
-
 on:
   pull_request:
 
 jobs:
   code-quality:
     runs-on: ubuntu-latest
     steps:
+      # Checkout branch
       - uses: actions/checkout@v4
-        with:
-          repository: ${{github.event.pull_request.head.repo.full_name}}
-          ref: ${{ github.head_ref }}
+      # Set up Flutter within the action
       - uses: subosito/flutter-action@v2
-        with:
-          cache: true
       - uses: ZebraDevs/flutter-code-quality@main
         with:
+          # Token used for authentication.
           token: ${{secrets.GITHUB_TOKEN}}
 ```
+
+## Contributing
+
+This project welcomes contributions. Pleae check out our [Contributing guide](CONTRIBUTING.md) to learn more on how to get started.
+
+### License
+
+This project is released under the [MIT License](./LICENSE).