Skip to content
Prompt

penguin — Cursor Rules

by Maximooch

AI Summary

A Cursor IDE prompt booster that establishes Python coding standards and modular design principles for bootstrapped startups seeking efficient, maintainable code architecture.

Install

Copy this and paste it into Claude Code, Cursor, or any AI assistant:

I want to add the "penguin — Cursor Rules" prompt rules to my project.
Repository: https://github.com/Maximooch/penguin

Please read the repo to find the rules/prompt file, then:
1. Download it to the correct location (.cursorrules, .windsurfrules, .github/prompts/, or project root — based on the file type)
2. If there's an existing rules file, merge the new rules in rather than overwriting
3. Confirm what was added

Description

🐧 is currently a work in progress... Stay tuned!

1. Pythonic Practices

• Elegance and Readability: Strive for elegant and Pythonic code that is easy to understand and maintain. • PEP 8 Compliance: Adhere to PEP 8 guidelines for code style, with Ruff as the primary linter and formatter. • Explicit over Implicit: Favor explicit code that clearly communicates its intent over implicit, overly concise code. • Zen of Python: Keep the Zen of Python in mind when making design decisions.

2. Modular Design

• Single Responsibility Principle: Each module/file should have a well-defined, single responsibility. • Reusable Components: Develop reusable functions and classes, favoring composition over inheritance. • Package Structure: Organize code into logical packages and modules.

3. Code Quality

• Comprehensive Type Annotations: All functions, methods, and class members must have type annotations, using the most specific types possible. • Detailed Docstrings: All functions, methods, and classes must have Google-style docstrings, thoroughly explaining their purpose, parameters, return values, and any exceptions raised. Include usage examples where helpful. • Thorough Unit Testing: Aim for high test coverage (90% or higher) using pytest. Test both common cases and edge cases. • Robust Exception Handling: Use specific exception types, provide informative error messages, and handle exceptions gracefully. Implement custom exception classes when needed. Avoid bare except clauses. • Logging: Employ the logging module judiciously to log important events, warnings, and errors.

Discussion

0/2000
Loading comments...

Health Signals

MaintenanceCommitted 1mo ago
Active
AdoptionUnder 100 stars
4 ★ · Niche
DocsMissing or thin
Undocumented

GitHub Signals

Stars4
Issues0
Updated1mo ago
View on GitHub
No License

My Fox Den

Community Rating

Sign in to rate this booster

Works With

Any AI assistant that accepts custom rules or system prompts

Claude
ChatGPT
Cursor
Windsurf
Copilot
+ more