oop-best-practices
Skill0 starsChanged 4 months agoNo licenceView on GitHub
Mandatory engineering best-practices and workflow reference for this repo (Python, TypeScript, React, FastAPI, Postgres). Use whenever writing, refactoring, reviewing, or extending code, AND whenever starting a new feature/bug/refactor, creating GitHub issues, moving project-board cards, opening a PR, merging, writing a commit message, touching user input or data boundaries, changing the schema, building React components, or about to introduce a new library or pattern. Covers OOP discipline (encapsulation, low coupling, high cohesion), design patterns (strategy, builder, factory, DI), naming hygiene (no magic numbers, use constants/enums), import placement (top-of-file only), test discipline (unit + integration after each unit of code, cost-gated integration tests), resilience patterns (exponential backoff on third-party API calls), branch flow (main ← dev ← feature, never push to main), the repo's PR template, the mandatory issue → plan → implement → PR → merge workflow with full transparency, context-budget handoff at ~20% remaining, stack consistency (no Pydantic + dataclass mixing, no second ORM, match existing libraries), concurrency (right kind only where it pays — async I/O, process pools; never threads for CPU work in Python), structured JSON logging with request_id/trace_id, secrets hygiene (never commit, settings via pydantic-settings/dotenv), OWASP-grounded security baseline (parameterized queries, Pydantic/Zod validation, AuthN+AuthZ on every protected route), Conventional Commits, Alembic+Postgres migration safety (backward-compatible, expand/contract, CONCURRENTLY indexes, lock_timeout), avoidance of monolithic files (one class per file, soft size limits, split at the seam), and React-specific habits (minimize useEffect — never for derived state or data fetching). Trigger this skill even for small additions — a one-method change should still respect these rules. Also trigger when asked to "follow project style", "do this properly", "make this production-grade", "open a PR", "merge to dev", "start working on X", or when a code review surfaces a pattern violation.
- Reads credentials
- Deletes or force-pushes
- Commits and pushes
1 other project uses a version of this.
Adopted by
Most recently taken up by
- luckys/agent-skillstheir own version, first seen Nov 1, 2026
Other versions1 project uses a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 1
- luckys/agent-skills★ 5same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository3 other files it gives its agents.
- granola-meeting-dashboardSkill
- graphifySkill
- iterative-deep-researchSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
41 rules. About 0 are common, 18 are distinctive, and 23 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈18
Distinctive · estimate
This author's own choices. Worth a look.
23
Very specific
Tied to their project's names, files or tools. Probably skip.
No licence file, so all rights are reserved — read it at the source. We count its rules but don't quote them. Read them on GitHub.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.