AI Prompts for Preventing API Contract Breaks

Please identify all functions or module exports that have been modified recently in my project. For each function, provide the original signature as well as the modified signature, clearly indicating the changes made. Additionally, include a brief explanation of why each change was necessary and how it impacts the overall functionality of the module. Format the output in a structured list for easy reference.

Please scan the project for all instances of calls to [FUNCTION_NAME] that do not conform to the new signature. For each occurrence, provide details including the file name, line number, and a brief description of the context in which the call is made. Additionally, summarize the differences between the old and new signatures for clarity. Format this information in a clear, organized list that I can easily review.

Please review the Cascade mode logs for changes made to [FUNCTION_NAME]. Provide a detailed summary of the changes, including the specific files that were affected and the nature of those changes. Additionally, highlight any potential impacts these changes may have on the overall functionality. Format your response in a clear, organized manner, and ensure it covers all relevant details for a comprehensive understanding.

Please review the following CLAUDE.md file content: [PASTE CONTENT]. Analyze the recent changes made to [FUNCTION_NAME] and confirm whether they comply with the specified rules. Provide a detailed assessment that includes any areas of non-compliance, suggestions for improvement, and an explanation of how the changes align or misalign with the established guidelines. Format your response in a structured manner, highlighting key points for clarity.

Analyze the impact of changes to [FUNCTION_NAME] across the entire project. Please provide a comprehensive list of all modules and files that depend on this function, including their specific roles and how they interact with it. Additionally, assess the potential consequences of these changes on each module, including any risks or issues that may arise. Format your response in a clear, organized manner, highlighting key dependencies and their relationships to [FUNCTION_NAME].

Please review the project code and identify all instances where the function [FUNCTION_NAME] is called. Update each call to ensure it matches the new signature, which includes the following parameters: [LIST NEW PARAMETERS]. After making the updates, provide a summary of the changes made, including the locations of the updated calls and any potential impacts on the overall functionality of the project.

Please review the import statements for the module [MODULE_NAME] and modify them to ensure they are consistent with the recent export changes. Identify any outdated or incorrect imports and provide corrected versions. Additionally, include comments explaining the changes made and any potential impacts on the module's functionality. Ensure that the final code adheres to best practices for module imports.

Identify any unintended changes made by Cascade mode that impact [FUNCTION_NAME]. Provide a detailed list of these changes, explaining how they affect the functionality and performance of the system. Then, outline the steps necessary to revert these changes effectively, ensuring that the original state of [FUNCTION_NAME] is restored. Include any potential risks or considerations to keep in mind during the reversion process.

Implement incremental changes to the [FUNCTION_NAME] by breaking down the process into manageable steps. For each change, provide a detailed description of what is being modified and why. After implementing each change, run a verification process to ensure that the functionality remains intact and that no new issues are introduced. Document the results of each verification step, including any errors encountered and how they were resolved, before moving on to the next change. This approach will help maintain stability throughout the development process.

Please confirm that all dependencies of [FUNCTION_NAME] have been updated to support its new signature. Provide a detailed list of each dependency, including the current version and the updated version. Additionally, explain any changes made to the dependency that may affect its functionality or compatibility with the new signature. If there are any issues or conflicts with the updates, outline the steps needed to resolve them.

Please run comprehensive unit and integration tests for the function [FUNCTION_NAME]. After executing the tests, provide a detailed report that includes the results of each test, highlighting any failures along with the reasons for those failures. Additionally, summarize any patterns or common issues that arise from the test results, and suggest potential fixes or areas for further investigation. Ensure the report is structured clearly for easy understanding.

Please simulate a typical user flow involving [FUNCTION_NAME]. Detail each step of the process, including the inputs provided by the user and the expected outputs at each stage. Confirm that the functionality works as intended without any errors, and provide a summary of any issues encountered during the simulation. Additionally, include suggestions for improvements or adjustments if any errors were found.

Please verify that all module exports for [MODULE_NAME] are correctly updated and functioning as intended. Provide a detailed report that includes: a list of all exports, their current status (working or not), and any discrepancies found during the validation process. Additionally, include recommendations for any necessary changes or updates to ensure proper functionality. Format the report in a clear and organized manner, suitable for review by the development team.

Please review the code in all files that interact with [FUNCTION_NAME] to ensure consistency. Identify and highlight any discrepancies in naming conventions, formatting, or logic that may exist between the different files. Provide a detailed report that includes specific examples of inconsistencies, along with suggestions for how to resolve them. The report should be structured clearly, with sections for each type of discrepancy found, and include recommendations for maintaining consistency moving forward.

Verify whether the changes made to [FUNCTION_NAME] comply with the rules outlined in the CLAUDE.md document. Provide a detailed assessment of each rule and indicate whether the changes meet the specified requirements. If any discrepancies are found, list them clearly and suggest potential modifications to ensure full compliance. Conclude with a summary of the overall adherence status.

Please draft a new rule for the CLAUDE.md documentation that addresses the propagation of all function signature changes. The rule should include specific guidelines on how to document these changes, the process for updating related documentation, and the importance of maintaining consistency across the codebase. Additionally, outline the steps developers should take when a function signature is modified, including any necessary reviews or approvals. Ensure the rule is clear, concise, and can be easily referenced by the development team.

Please add detailed comments throughout the codebase that explain the significance of maintaining API contracts for [FUNCTION_NAME]. Each comment should clarify the purpose of the API contract, how it impacts the overall functionality, and the potential consequences of not adhering to these contracts. Additionally, provide examples of scenarios where breaking the API contract could lead to issues, and suggest best practices for ensuring compliance. Aim for clarity and thoroughness to enhance understanding for future developers working on this code.

Create a comprehensive checklist for updating function signatures in a codebase. The checklist should include steps to identify all dependent files that need revision, methods for ensuring compatibility with existing code, and a review process for testing the changes. Additionally, include guidelines for documenting the updates and communicating changes to the team. Format the checklist in a clear, organized manner with bullet points for each step.

Propose a detailed naming convention for functions and modules that clearly indicates when a change necessitates widespread updates. Include specific examples of naming patterns that can be used to signal different types of changes, such as breaking changes, deprecations, and minor updates. Explain the rationale behind your proposed conventions and how they can help developers quickly understand the impact of changes. Additionally, provide guidelines on how to document these conventions within the codebase to ensure consistency and clarity for all team members.

Help me establish project guards that will trigger alerts whenever a function signature is altered without corresponding updates. I want to ensure that any changes to the function signatures are closely monitored to prevent potential issues in the codebase. Please outline the specific criteria for triggering these alerts, the format of the alerts, and how the notifications should be delivered. Additionally, provide recommendations on how to document these guards for future reference and maintenance.