← Back to list

general
by kevincrabbe
⭐ 0🍴 0📅 Jan 5, 2026
SKILL.md
name: general description: General development guidelines prioritizing readability over performance, with rules for meaningful comments. Use when writing any code in this project.
General Development Guidelines
Apply these general guidelines to all code.
Priorities
Focus 80% on readability and 20% on performance.
In order of importance:
- Correctness and functionality
- Readability & Maintainability
- Performance
Comments
Add comments only when they explain WHY, not WHAT. The code itself should be readable enough to show WHAT it does.
DO NOT comment obvious operations
// Bad
// increment counter
counter++;
DO comment
- Business logic reasoning
- Non-obvious decisions
- Workarounds or edge cases
- Complex algorithms (brief summary of approach)
Example of a good comment
// Using ceil() here because partial units must be charged as full units per billing policy
const billableUnits = Math.ceil(usage / unitSize);
Score
Total Score
50/100
Based on repository quality metrics
✓SKILL.md
SKILL.mdファイルが含まれている
+20
○LICENSE
ライセンスが設定されている
0/10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
○最近の活動
3ヶ月以内に更新がある
0/10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
○タグ
1つ以上のタグが設定されている
0/5
Reviews
💬
Reviews coming soon