Skip to content

Add new prompts for automation, error handling, documentation, and architecture summary #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add new prompts for automation, error handling, documentation, and architecture summary #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@
- `// Implement a data class for this dictionary structure...`
<sub>Useful for Python projects moving towards more structured data handling with `dataclasses` or Pydantic.</sub>

- `// Generate a shell script to automate {a specific} workflow...`
<sub>For automating repetitive tasks in any project.</sub>



## Debugging
Expand All @@ -76,6 +79,9 @@
- `// Add print statements to trace the execution flow of this Python script...`
<sub>For debugging complex Python scripts or understanding unexpected behavior.</sub>

- `// Add error handling to {a specific} function`
<sub>Improves reliability by catching and reporting exceptions.</sub>


## Documentation

Expand All @@ -91,6 +97,12 @@
- `// Generate Sphinx-style docstrings for this Python module/class/function...`
<sub>Ideal for Python projects using Sphinx for documentation generation.</sub>

- `// Generate a changelog entry for {a specific} feature`
<sub>Keeps project history clear and up to date.</sub>

- `// Create a code example for {a specific} API method`
<sub>Makes documentation more actionable for users.</sub>



## Testing
Expand Down Expand Up @@ -160,6 +172,9 @@
- `// Refactor this Python function to be more amenable to parallel processing (e.g., using multiprocessing or threading)...`
<sub>For optimizing performance in computationally intensive Python applications.</sub>

- `// Generate a summary of this codebase's architecture`
<sub>Helps new contributors understand the project structure.</sub>



## Context
Expand Down