PromptBase
Close icon
General
Home
Marketplace
Hire
Create
Login
Sell
Explore
🤖 GPT

Code Review Assistance Prompt

Code Review Assistance Prompt gpt prompt mini thumbnail
2Heart icon
Favorites
29Eye icon
Views
GPT-4
TestedTick icon
TipsTick icon
The provided template is a detailed guide for conducting a code review of a script written in a specified programming language. It outlines key areas to focus on, including code readability, optimization, functionality, security, testing, and documentation. Users are instructed to replace placeholders with specific details to tailor the review to their script, ensuring a comprehensive evaluation of the code's quality, efficiency, and adherence .
...more
$2.99
Get prompt
After purchasing, you will gain access to the prompt file which you can use with GPT or the app builder. You'll receive 20 free generation credits with this purchase. By purchasing this prompt, you agree to our terms of service.
Over 1 month ago

Prompt Details

Model
Chat - GPT-4 (gpt-4)
Token size
749 ($0.15729 / call)
Example input
Python Script Code Review Code Readability and Structure: Variable Naming: Are the variable names like userList and processData clear and indicative of their usage in the script? Function Naming: Do function names like calculateTotal accurately describe what the function does? Comments: Are there sufficient comments explaining the logic behind critical sections of the code, especially complex functions? Structure: Is the script segmented into logical blocks or modules, making it easy to navigate and understand? Optimization and Performance: Redundant Code: Is there any redundant code, such as unnecessary loop iterations or repeated calculations that could be optimized? Efficient Data Structures: Are there opportunities to use more efficient data structures like set or dict instead of lists for faster lookup times? Memory Usage: Are there any parts of the code that could potentially lead to memory leaks or excessive memory consumption? Functionality and Correctness: Requirement Alignment: Does the script fulfill all the functional requirements specified in the project documentation? Edge Case Handling: Are there checks in place to handle unexpected or invalid input data? Error Handling: Does the script include robust error handling to manage exceptions and unexpected situations gracefully? Security and Best Practices: Security Flaws: Are there any sections of the code vulnerable to SQL injection or other security threats? Pythonic Practices: Does the script follow Pythonic best practices, such as using list comprehensions where appropriate or leveraging Python's standard libraries effectively? Testing and Documentation: Unit Tests: Are there comprehensive unit tests covering a wide range of scenarios, including edge cases? Documentation: Is there clear documentation, both within the code (inline comments) and external (like a README file), explaining how to run the script and what each part does? Suggestions for Improvement: Code Refactoring: Could any functions be refactored for better clarity or performance? Additional Features: Are there suggestions for new features or enhancements that could improve the script's functionality or user experience? This preview demonstrates how the code review guide can be applied to a specific Python script, providing a structured and thorough approach to evaluating its quality, efficiency, and effectiveness.
Example output
Python Script Code Review Output Code Readability and Structure: Variable Naming: The variables userList and processData are well-named, clearly indicating their purpose and content. Function Naming: The function calculateTotal is aptly named, reflecting its functionality accurately. Comments: The script is well-commented, especially around complex blocks, providing clarity on the implemented logic. Structure: The code is well-organized into modules and functions, making it easy to follow and maintain. Optimization and Performance: Redundant Code: A loop in the processData function appears to recalculate values unnecessarily, which can be optimized. Efficient Data Structures: Switching from lists to sets in the uniqueUsers function will improve the data lookup times significantly. Memory Usage: No apparent memory leaks are detected, but monitoring large dataset processing would be advisable. Functionality and Correctness: Requirement Alignment: The script meets all outlined functional requirements, processing and outputting data as expected. Edge Case Handling: Edge cases are considered, but adding more robust checks for invalid input data could enhance stability. Error Handling: Error handling is present but could be more descriptive in providing feedback for troubleshooting. Security and Best Practices: Security Flaws: No immediate security vulnerabilities are found. However, ensuring data sanitization, especially when integrating with databases or external inputs, is recommended. Pythonic Practices: The script follows Pythonic conventions, but some loops could be converted to list comprehensions for better readability and efficiency. Testing and Documentation: Unit Tests: The script includes a comprehensive set of unit tests, which cover most functionalities. Adding tests for new edge cases identified could further improve reliability. Documentation: The inline comments and README file provide clear instructions and insights into the script's functionality, aiding in its usability and maintainability. Suggestions for Improvement: Code Refactoring: Refactoring the processData function to eliminate redundant calculations could improve performance. Additional Features: Considering the addition of a feature to export processed data in various formats could enhance the script's versatility and user experience. This output demonstrates how the provided code review guide can be utilized to produce a detailed and structured evaluation of a Python script, highlighting strengths and areas for improvement, and providing actionable feedback for enhancement.
Browse Marketplace