46 lines
2.8 KiB
Markdown
46 lines
2.8 KiB
Markdown
# AI Blueprint: Full Project Readiness Audit
|
|
|
|
## Goal
|
|
|
|
To perform a comprehensive audit of the `IYmtg_App_iOS` project to ensure it can be compiled without errors and to identify any missing or incomplete features before handing it off to a human developer.
|
|
|
|
## Audit Steps for Claude
|
|
|
|
1. **Dependency Verification:**
|
|
* Review the project's dependencies. Since this is a Swift project, check for any package manager configurations (like Swift Package Manager, CocoaPods, or Carthage). If any are found, ensure all required dependencies are listed and correctly configured.
|
|
* Verify that all required versions of dependencies are compatible with the project's Swift version.
|
|
|
|
2. **File and Resource Integrity Check:**
|
|
* Scan the project for any missing files or broken links. Pay close attention to assets, storyboards, and any other resources referenced in the code.
|
|
* Ensure all necessary `.swift` files are included in the build targets.
|
|
|
|
3. **Static Code Analysis:**
|
|
* Perform a static analysis of the entire Swift codebase in `IYmtg_App_iOS/`.
|
|
* Look for common compilation issues such as:
|
|
* Syntax errors.
|
|
* Type mismatches.
|
|
* Unresolved identifiers (e.g., variables or functions that are used but not defined).
|
|
* Incorrect use of optionals.
|
|
* API deprecation warnings.
|
|
|
|
4. **Feature Completeness Review:**
|
|
* Examine the code for any features that are stubbed out, marked with `// TODO:`, `// FIXME:`, or are otherwise incomplete.
|
|
* Pay special attention to the `Features` directory (`IYmtg_App_iOS/Features/`) to assess the state of each feature (CardDetail, Collection, Help, Scanner).
|
|
* Check for any disabled or commented-out code that might indicate an incomplete feature.
|
|
|
|
5. **Audit Summary Report:**
|
|
* Create a summary of all findings in a new file named `claude_review_summary.md`.
|
|
* For each issue, provide a description, the file path, and the relevant line number(s).
|
|
* Categorize the issues by severity (e.g., Blocker, Critical, Major, Minor).
|
|
|
|
6. **Update README.md:**
|
|
* Add a new section to the `README.md` file titled "Project Audit".
|
|
* Under this section, add a brief summary of the audit's outcome and a link to the `claude_review_summary.md` file.
|
|
|
|
7. **Create Git Commit:**
|
|
* Stage all the changes (the new `claude_review_summary.md` and the updated `README.md`).
|
|
* Create a Git commit with the message: "feat: Complete project readiness audit".
|
|
|
|
8. **Increment Project Version:**
|
|
* If the audit reveals significant issues that require code changes, increment the project's build number. If no significant issues are found, this step can be skipped. The location of the version number is likely in the project's settings or an `Info.plist` file.
|