Initial commit
This commit is contained in:
@@ -0,0 +1,80 @@
|
||||
# [directory-name]/
|
||||
|
||||
<!-- Replace [directory-name] with the actual directory name -->
|
||||
|
||||
This directory contains [brief description of what this directory contains].
|
||||
|
||||
## Overview
|
||||
|
||||
<!-- 2-3 sentences explaining the purpose and scope -->
|
||||
|
||||
## Directory Structure
|
||||
|
||||
<!-- If the directory has subdirectories, show them here -->
|
||||
|
||||
```
|
||||
[directory-name]/
|
||||
├── subdirectory1/ # Description
|
||||
├── subdirectory2/ # Description
|
||||
└── file.ext # Description
|
||||
```
|
||||
|
||||
## Key Files
|
||||
|
||||
<!-- Highlight the most important files and their roles -->
|
||||
|
||||
- **file1.ext**: Description of what this file does
|
||||
- **file2.ext**: Description of what this file does
|
||||
|
||||
## Important Patterns
|
||||
|
||||
<!-- Document conventions, patterns, or standards used -->
|
||||
|
||||
### Pattern Name
|
||||
|
||||
Description and example of the pattern.
|
||||
|
||||
## Dependencies
|
||||
|
||||
### Internal Dependencies
|
||||
<!-- What this code depends on from elsewhere in the codebase -->
|
||||
|
||||
- `src/path/to/dependency` - Description
|
||||
|
||||
### External Dependencies
|
||||
<!-- Third-party libraries or services -->
|
||||
|
||||
- Package Name - Purpose
|
||||
|
||||
### Used By
|
||||
<!-- What other parts of the codebase depend on this -->
|
||||
|
||||
- `src/path/to/dependent` - How it uses this code
|
||||
|
||||
## Usage
|
||||
|
||||
<!-- How to work with this code, with examples -->
|
||||
|
||||
Example usage:
|
||||
```typescript
|
||||
// Code example
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
<!-- How to test this code -->
|
||||
|
||||
```bash
|
||||
npm run test:this-area
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
<!-- Any gotchas, known issues, or additional context -->
|
||||
|
||||
- Important note 1
|
||||
- Important note 2
|
||||
|
||||
---
|
||||
|
||||
*Last Updated: YYYY-MM-DD*
|
||||
Reference in New Issue
Block a user