AI Prompts for Ensuring Consistent API Contracts

Please identify all function signatures and module exports that have been modified recently in the codebase. For each change, include the following details: the specific file name where the modification occurred, the line numbers of the changes, and a brief description of what was altered in each signature or export. Format the output as a structured list to ensure clarity and ease of reference.

Please search the entire codebase for references to [FUNCTION_NAME] or [MODULE_EXPORT]. Identify and list all files that contain references which do not match the updated signature or export. For each file, provide a brief description of the discrepancies found, including the specific lines where the mismatches occur. Additionally, suggest potential steps to resolve these inconsistencies and ensure that all references are updated accordingly.

Analyze the last five commits made to the [FUNCTION_NAME] or [MODULE_EXPORT]. For each commit, provide a summary of the specific changes that were made, including any additions, deletions, or modifications to the code. Explain the purpose of these changes and how they impact the overall functionality or performance of the module. Additionally, highlight any potential issues or improvements that could arise from these alterations. Format your response as a detailed report.

Please locate all call sites for the function [FUNCTION_NAME] throughout the entire project. For each call site, confirm whether it aligns with the new function signature, detailing any discrepancies found. Additionally, provide a summary of the changes needed to ensure compatibility with the updated signature, including suggestions for refactoring if necessary. Format your findings in a clear report, highlighting each call site and its status regarding alignment.

Identify any external modules or dependencies that rely on [MODULE_EXPORT]. Assess the potential impact of recent changes on these dependencies and determine if they require updates to function correctly. Provide a detailed analysis of each dependency, including the nature of its reliance on [MODULE_EXPORT], any necessary modifications, and the implications of not updating them. Format your findings in a structured report that highlights critical dependencies, their current status, and recommended actions.

Please update all instances of [FUNCTION_NAME] in the codebase to match the new signature. For each modification, provide the file name and line number where the change was made. Additionally, summarize the changes in a brief report that outlines the old and new signatures for clarity. Ensure that the code remains functional and adheres to best practices throughout the update process.

Review the module exports for [MODULE_NAME] and ensure they align with the new structure. Identify and list any files that required modifications to meet this standard. Provide a brief explanation of the changes made for each file, including the reasons for the adjustments and how they improve consistency. Additionally, summarize any potential impacts these changes may have on the overall functionality of the module.

Refactor the dependent code that interacts with [FUNCTION_NAME] or [MODULE_EXPORT] to enhance stability and prevent runtime errors. Identify all instances where this code is called and analyze how it interacts with other components. Provide a detailed explanation of the changes made, including the rationale behind each modification and how it improves the overall functionality. Ensure that the refactored code is well-structured, follows best practices, and includes comments for clarity. Finally, test the refactored code to confirm that it resolves any potential runtime issues.

Please update the documentation and comments related to [FUNCTION_NAME] and [MODULE_EXPORT] to accurately reflect the recent changes made. Ensure that all relevant sections are revised for clarity and completeness, including any usage examples, parameters, return values, and potential exceptions. Additionally, check for consistency in terminology and formatting throughout the documentation. Provide a summary of the changes made and highlight any sections that required significant updates or clarification.

Please run comprehensive tests on all updated interfaces to verify their functionality with the new signatures or exports. Ensure that each interface is tested under various scenarios to identify any potential issues or discrepancies. Provide a detailed report on the results, highlighting any failures or unexpected behaviors, along with suggested fixes or improvements for each identified issue. Include examples of test cases used and the expected versus actual outcomes for clarity.

Please execute a comprehensive test suite to verify that the updated function signatures and module exports do not introduce any errors. Include tests for all critical functionalities and edge cases to ensure robustness. Provide a detailed report of the test results, highlighting any failures or issues encountered, along with suggestions for resolving them. Additionally, summarize the overall impact of the changes on the existing codebase and any areas that may require further attention.

Please compile the entire project and identify any compilation errors that arise specifically related to [FUNCTION_NAME] or [MODULE_EXPORT]. Provide a detailed report that includes the nature of each error, the line numbers where they occur, and any suggestions for resolving these issues. Additionally, summarize any potential impacts these errors may have on the overall functionality of the project. Ensure the report is clear and structured for easy reference.

Please validate the functionality of all external dependencies interacting with [MODULE_EXPORT]. Provide a detailed report on each dependency, including its current status, any issues encountered, and the steps taken to resolve them. Additionally, assess the impact of these dependencies on the overall performance of the module and suggest any improvements or changes that could enhance reliability. Format the report in a clear and organized manner, with sections for each dependency and a summary of findings at the end.

Please analyze the log outputs from the recent changes to identify any warnings or errors. Summarize your findings in a structured format, highlighting the key issues and their potential impact on system performance. Include specific examples of any warnings or errors found, along with recommendations for addressing them. The summary should be concise, ideally no more than one page, and should clearly outline the steps that can be taken to resolve any identified issues.

Please verify the consistency of all code references to [FUNCTION_NAME] and [MODULE_EXPORT] throughout the entire project. Identify any discrepancies or variations in naming, syntax, or usage. Provide a detailed report that includes the locations of any inconsistencies, suggestions for corrections, and an overall assessment of the code's adherence to the defined standards. Ensure the report is structured clearly, with sections for each identified issue and recommended resolutions.

Please draft a new rule for the CLAUDE.md document that enforces checks on function signature changes. The rule should clearly outline the criteria for what constitutes a change in function signatures, including any parameters, return types, and visibility modifiers. Additionally, specify the consequences for not adhering to this rule, and provide examples of both compliant and non-compliant function signatures. Format the rule in a clear and concise manner, suitable for inclusion in the existing documentation.

Help me develop a comprehensive naming convention for function signatures that facilitates easy identification of changes. The convention should include guidelines on how to structure names based on the function's purpose, parameters, and return types. Provide at least five examples of function signatures that adhere to this convention, explaining how each example illustrates the principles of the naming convention. Additionally, outline any best practices for maintaining consistency in naming across a codebase.

Create a pre-commit hook script that automatically checks for unupdated references whenever function signatures or module exports are modified in the codebase. The script should analyze the changes made in the commit and identify any discrepancies between the modified signatures and their corresponding references throughout the project. If any unupdated references are found, the script should prevent the commit and provide a detailed report listing the affected references and the necessary updates required. Ensure the script is compatible with [VERSION CONTROL SYSTEM] and can be easily integrated into existing workflows.

Create a comprehensive checklist for developers to follow when altering function signatures or module exports in a codebase. The checklist should include key steps such as reviewing existing documentation, ensuring backward compatibility, updating relevant tests, communicating changes to the team, and verifying the impact on dependent modules. Additionally, include a section for common pitfalls to avoid and best practices to maintain code integrity. Format the checklist in a clear, organized manner with bullet points for easy reference.

Please insert detailed comments in the codebase near the sections for [FUNCTION_NAME] and [MODULE_EXPORT]. The comments should emphasize the importance of updating all references whenever changes are made to these components. Include specific examples of what needs to be updated and why it is crucial for maintaining code integrity. Ensure the comments are clear and concise, making it easy for future developers to understand the context and significance of these updates.