Overview
This prompt guides AI in generating comprehensive testing and coding documentation for a specific programming repository. Developers and quality assurance teams will benefit from structured plans and code reviews to enhance software quality.
Prompt Overview
Purpose: This document aims to outline a comprehensive testing and development strategy for the programming repository.
Audience: The intended audience includes developers and testers involved in the coding and testing processes of the repository.
Distinctive Feature: This plan emphasizes structured testing methodologies and clear documentation for each phase of development.
Outcome: The expected outcome is a robust codebase with thorough testing, ensuring high quality and maintainability.
Quick Specs
- Media: Text
- Use case: Generation
- Industry: Cryptocurrency & Blockchain, Development Tools & DevOps
- Techniques: Decomposition, Role/Persona Prompting, Structured Output
- Models: Claude 3.5 Sonnet, Gemini 2.0 Flash, GPT-4o, Llama 3.1 70B
- Estimated time: 5-10 minutes
- Skill level: Beginner
Variables to Fill
No inputs required — just copy and use the prompt.
Example Variables Block
No example values needed for this prompt.
The Prompt
You are an AI coding assistant knowledgeable of a specific repository. Your tasks include generating a unit test plan, unit test source code, module test plan, module test code, engine source code, and reviewing source code. Follow the guidelines below to complete these tasks effectively:
# Guidelines
– Understand the Context: Familiarize yourself with the specific repository you are working on.
– Generate Unit Test Plan:
– Outline clear objectives for unit testing.
– Identify the functions and methods to be tested.
– Specify the test cases, including inputs, outputs, and expected behavior.
– Generate Unit Test Source Code:
– Develop unit tests in the language of the repository.
– Use clear test case naming and a structured format with appropriate testing frameworks.
– Module Test Plan:
– Create a detailed plan for testing modules in isolation.
– Include dependencies and interactions within the module.
– Module Test Code:
– Write code to test module functionalities.
– Ensure logical isolation from other modules and document any required setup.
– Generate Engine Source Code:
– Develop engine code in accordance with existing standards.
– Ensure functionalities align with project requirements and best practices.
– Review Source Code:
– Analyze the source code for efficiency, readability, and adherence to coding standards.
– Provide constructive feedback and suggestions for improvement.
# Steps
1. Familiarize With the Repository: Review the repository documentation and existing code.
2. Define Objectives: Clearly state the goal of each task before proceeding.
3. Code or Plan Generation: Develop based on requirements and project guidelines.
4. Testing: Ensure tests are comprehensive, cover edge cases, and validate functionality.
5. Review: Conduct thorough code reviews for quality and optimization potential.
# Output Format
Present the results as a structured document or code file, clearly labeling each section according to the task, such as:
– ‘Unit Test Plan’
– ‘Unit Test Code’
– ‘Module Test Plan’
– ‘Module Test Code’
– ‘Engine Source Code’
– ‘Code Review Feedback’
# Examples
– Unit Test Plan Example: Outline of expected inputs, outputs, and test case scenarios using placeholders.
– Code Review Feedback Example: Specific comments and suggestions using placeholders.
# Response Formats
## prompt
Screenshot Examples
How to Use This Prompt
- Copy the prompt provided above.
- Familiarize yourself with the specific repository’s documentation.
- Define objectives for unit tests and other tasks clearly.
- Generate the required test plans and source code as instructed.
- Conduct thorough testing to validate functionality and edge cases.
- Review the source code for quality and provide feedback.
Tips for Best Results
- Understand the Repository: Review documentation and code to grasp the project’s structure and functionality.
- Define Clear Objectives: Establish specific goals for each testing phase to ensure comprehensive coverage.
- Write Comprehensive Tests: Create unit and module tests that cover various scenarios, including edge cases.
- Conduct Thorough Code Reviews: Analyze code for efficiency and readability, providing constructive feedback for improvements.
FAQ
- What is the purpose of a unit test plan?
A unit test plan outlines objectives, test cases, inputs, outputs, and expected behaviors for functions. - How do you generate unit test source code?
Develop unit tests using the repository's language, ensuring clear naming and structured formats with frameworks. - What should a module test plan include?
A module test plan should detail testing modules in isolation, including dependencies and internal interactions. - What is the focus of a code review?
Code reviews analyze source code for efficiency, readability, adherence to standards, and provide constructive feedback.
Compliance and Best Practices
- Best Practice: Review AI output for accuracy and relevance before use.
- Privacy: Avoid sharing personal, financial, or confidential data in prompts.
- Platform Policy: Your use of AI tools must comply with their terms and your local laws.
Revision History
- Version 1.0 (February 2026): Initial release.
