Skip to content

Commit

Permalink
chore(instruction): Streamline development instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
yamadashy committed Jan 1, 2025
1 parent 551e400 commit 5acc5d2
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 14 deletions.
20 changes: 6 additions & 14 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
# Repomix Development Instructions

Repomix is a tool that packs repository contents into a single file for AI analysis. When modifying or adding code:

## Development Standards
- Use TypeScript with strict type checking and proper error handling via RepomixError class
- Support cross-platform compatibility (Windows/Unix paths)
- Use logger utility for console output and picocolors for colored text

## Core Architecture
- /src/core: Main file processing and packing logic
- /src/cli: Command-line interface components
- /src/config: Configuration management (Zod schemas)
- /src/shared: Common utilities and types
# Coding Guidelines
- Follow the Airbnb JavaScript Style Guide
- Suggest splitting files into smaller, focused units when appropriate
- Keep code files under 250 lines, if the file is over 250 lines, split it into multiple files based on the functionality.
- Add comments for non-obvious logic. Keep all text in English
- All new features should have corresponding unit tests

## Dependencies and Testing
- Inject dependencies through a deps object parameter for testability
Expand Down
19 changes: 19 additions & 0 deletions repomix-instruction.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,28 @@
# Coding Guidelines
- Follow the Airbnb JavaScript Style Guide
- Suggest splitting files into smaller, focused units when appropriate
- Keep code files under 250 lines, if the file is over 250 lines, split it into multiple files based on the functionality.
- Add comments for non-obvious logic. Keep all text in English
- All new features should have corresponding unit tests

## Dependencies and Testing
- Inject dependencies through a deps object parameter for testability
- Example:
```typescript
export const functionName = async (
param1: Type1,
param2: Type2,
deps = {
defaultFunction1,
defaultFunction2,
}
) => {
// Use deps.defaultFunction1() instead of direct call
};
```
- Mock dependencies by passing test doubles through deps object
- Use vi.mock() only when dependency injection is not feasible

# Generate Comprehensive Output
- Include all content without abbreviation, unless specified otherwise
- Optimize for handling large codebases while maintaining output quality
Expand Down

0 comments on commit 5acc5d2

Please sign in to comment.