Skip to content

Refine AI context files #89

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

Closed
ai-coding-guardrails-maxi-sandbox wants to merge 1 commit into from
Closed

Refine AI context files #89

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
31 changes: 5 additions & 26 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,32 +81,11 @@ Common cookiecutter variables:

## Error Patterns to Avoid

```python
# BAD: Using os.path
import os
file_path = os.path.join(os.getcwd(), "file.txt")

# GOOD: Using pathlib
from pathlib import Path
file_path = Path.cwd() / "file.txt"

# BAD: Print for logging
print(f"Error: {error}")

# GOOD: Proper logging
import logging
logger = logging.getLogger(__name__)
logger.error(f"Operation failed: {error}")

# BAD: Generic exceptions
except Exception:
pass

# GOOD: Specific handling
except FileNotFoundError as e:
logger.error(f"Configuration file not found: {e}")
raise
```
| BAD | GOOD |
|-----|------|
| `os.path.join(os.getcwd(), "file.txt")` | `Path.cwd() / "file.txt"` (use `pathlib`) |
| `print(f"Error: {error}")` | `logger.error(f"Operation failed: {error}")` (use `logging`) |
| `except Exception: pass` | `except FileNotFoundError as e: logger.error(...); raise` |

## Testing Guidelines

Expand Down
Loading