-
Notifications
You must be signed in to change notification settings - Fork 26
Expand file tree
/
Copy path103-readme.mdc
More file actions
124 lines (100 loc) · 2.62 KB
/
Copy path103-readme.mdc
File metadata and controls
124 lines (100 loc) · 2.62 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
---
description: ENFORCE README.md standards to ensure comprehensive project documentation
globs: **/README.md
---
# README Standards
## Context
- When creating or updating project documentation
- When adding new features or dependencies
- When changing project structure
- When updating installation or usage instructions
## Requirements
### Core Structure
- Title and Description
- Project name
- Clear, concise description of purpose
- Status badges (build, coverage, version)
- Table of Contents
- Auto-generated for READMEs longer than 2 screens
- Hierarchical structure with clickable links
- Project Overview
- Problem statement
- Solution overview
- Key features
- Technologies used with versions
- Architecture diagram (if applicable)
- Getting Started
- Prerequisites
- Installation steps
- Environment setup
- Configuration
- Usage
- Basic examples
- Common use cases
- API documentation (if applicable)
- Screenshots/GIFs for UI features
- Development
- Setup instructions
- Testing procedures
- Contribution guidelines
- Code style guide
- Branch naming conventions
- Project Structure
- Directory layout
- Key files and their purposes
- Architecture overview
- Deployment
- Build instructions
- Deployment procedures
- Environment variables
- Infrastructure requirements
- Maintenance
- Update procedures
- Troubleshooting guide
- Known issues
- FAQ
### Formatting
- Use proper Markdown syntax
- Include syntax highlighting for code blocks
- Keep line length under 120 characters
- Use relative links for internal references
- Include alt text for images
### Updates
- Keep version numbers current
- Update documentation with each feature
- Maintain changelog
- Review and update quarterly
## Examples
<example>
# CV Generator
@
@
@
Modern CV generator supporting JSON Resume format with real-time preview.
## Features
- JSON Resume format support
- Real-time preview
- Multiple themes
- PDF export
- Responsive design
## Quick Start
```bash
pnpm install
pnpm dev
```
@View full documentation
</example>
<example type="invalid">
cv generator app
install:
npm install
npm start
made by john
</example>
## Critical Notes
<critical>
- NEVER commit sensitive information (API keys, credentials)
- ALWAYS update version numbers when making changes
- ENSURE all commands and procedures are tested before documenting
- MAINTAIN synchronization between code and documentation
</critical>