diff --git a/README.md b/README.md index 477bc01..5e3d52a 100644 --- a/README.md +++ b/README.md @@ -4,40 +4,50 @@ Welcome to the **Engineering Prompts** repository! This repository contains a co Each prompt chain is designed to build context for ChatGPT before executing a task. They can be used in **ChatGPT Queue** for bulk prompting, job, or task-focused automation. -## Domains Covered - -This repository contains prompt chains for the following domains: - -1. **Code Refactoring & Development** -2. **CI/CD & DevOps** -3. **Database Management** -4. **Cloud & Kubernetes** -5. **Full-Stack Development** -6. **UX/UI & Design** -7. **Security & Authentication** -8. **Event-Driven Architecture & Integration** -9. **Content Creation & Marketing** -10. **Infrastructure & System Administration** -11. **System Monitoring & Debugging** -12. **Web Development** -13. **API Development** +## Features + +Comprehensive Prompt Library: Covers a wide range of engineering domains. +Structured & Searchable: Prompts are categorized and tagged for easy navigation. +Ready-to-Use Templates: Includes prompt templates and usage examples. +Collaboration Friendly: Supports team contributions and versioning. +Automation Integration: Designed for use with tools like ChatGPT Queue and CI/CD pipelines. + +## Domain Overview & Example Use Cases +This repository provides AI-powered prompt chains tailored for specific engineering domains. Each domain includes real-world use cases to help developers automate and accelerate common tasks. + +| **Domain** | **Example Use Cases** | +| ---------------------------------- | ------------------------------------------------------------------- | +| **Code Refactoring & Development** | Code readability, language translation, debugging assistance | +| **CI/CD & DevOps** | CI/CD pipeline setup, deployment automation | +| **Database Management** | SQL query generation, database optimization | +| **Cloud & Kubernetes** | Cluster provisioning, cloud storage configuration | +| **Full-Stack Development** | Building web apps, API integration | +| **UX/UI & Design** | UI/UX enhancements, accessibility improvements | +| **Security & Authentication** | Security audits, JWT and OAuth2 implementation | +| **Event-Driven Architecture** | Kafka pipelines, webhook and third-party integrations | +| **Content Creation & Marketing** | Portfolio writing, SEO content generation | +| **Infrastructure & SysAdmin** | Infrastructure as Code (IaC), serverless setup, system provisioning | +| **System Monitoring & Debugging** | Performance analysis, logging configuration | +| **Web Development** | Testing strategies, deployment pipelines | +| **API Development** | OpenAPI spec generation, curl/HTTP request building | --- ## Use Cases and Prompts ### **1. Code Refactoring & Development** +Accelerate software quality improvements with prompts focused on clarity, optimization, and productivity. Ideal for developers who want to refactor, debug, or automate coding tasks * **Refactor Code for Better Readability** ```text - "Please review the provided code and identify areas where readability can be improved. Focus on simplifying complex functions, improving variable names, and removing redundant code. Return the refactored code and explain the changes made to improve readability." + "Please review the provided code and identify areas where readability can be improved. Focus on simplifying complex functions, improving variable names, and removing redundant code. Return the refactored code and explain the changes made." ``` * **Translate Code from One Language to Another** ```text - "Translate the provided code from {source_language} to {target_language}. Ensure that the functionality remains equivalent. Highlight major differences in syntax or constructs between the two languages and explain the changes." + "Translate the provided code from {source_language} to {target_language}. Ensure equivalent functionality and highlight key syntax or structural differences." ``` * **Create Documentation from Code** @@ -455,6 +465,12 @@ This repository contains prompt chains for the following domains: ```text "Write unit and integration tests for the provided front-end components using {testing_framework}. Ensure the tests cover all major use cases and edge cases. Return the test code with explanations." ``` +* **Perform End-to-End Testing with Cypress** + ```text + ""Set up Cypress for end-to-end (E2E) testing of the front-end application. Write Cypress tests that simulate user interactions such as adding, completing, and deleting items in a To-Do list. Ensure tests validate full user flows, handle edge cases, and assert the correct UI behavior. Provide setup instructions, Cypress configuration, and E2E test code with comments explaining each scenario." + ``` + + --- @@ -494,4 +510,4 @@ This repository contains prompt chains for the following domains: ```text "Set up a CI/CD pipeline to automatically run Keploy tests as part of the deployment process. Include configuration for GitHub Actions or Jenkins to run tests whenever new code is pushed to the repository." - ``` \ No newline at end of file + ```