55fe7d10eb
- Fix all TypeScript compilation errors (40+ fixes) - Add missing type definitions (TransactionRequest, SafeInfo) - Fix TransactionRequestStatus vs TransactionStatus confusion - Fix import paths and provider type issues - Fix test file errors and mock providers - Implement comprehensive security features - AES-GCM encryption with PBKDF2 key derivation - Input validation and sanitization - Rate limiting and nonce management - Replay attack prevention - Access control and authorization - Add comprehensive test suite - Integration tests for transaction flow - Security validation tests - Wallet management tests - Encryption and rate limiter tests - E2E tests with Playwright - Add extensive documentation - 12 numbered guides (setup, development, API, security, etc.) - Security documentation and audit reports - Code review and testing reports - Project organization documentation - Update dependencies - Update axios to latest version (security fix) - Update React types to v18 - Fix peer dependency warnings - Add development tooling - CI/CD workflows (GitHub Actions) - Pre-commit hooks (Husky) - Linting and formatting (Prettier, ESLint) - Security audit workflow - Performance benchmarking - Reorganize project structure - Move reports to docs/reports/ - Clean up root directory - Organize documentation - Add new features - Smart wallet management (Gnosis Safe, ERC4337) - Transaction execution and approval workflows - Balance management and token support - Error boundary and monitoring (Sentry) - Fix WalletConnect configuration - Handle missing projectId gracefully - Add environment variable template
73 lines
1.2 KiB
Markdown
73 lines
1.2 KiB
Markdown
# Contributing Guide
|
|
|
|
Thank you for your interest in contributing to Impersonator!
|
|
|
|
## Getting Started
|
|
|
|
1. Fork the repository
|
|
2. Clone your fork
|
|
3. Create a feature branch
|
|
4. Make your changes
|
|
5. Write/update tests
|
|
6. Submit a pull request
|
|
|
|
## Development Workflow
|
|
|
|
### 1. Create Feature Branch
|
|
|
|
```bash
|
|
git checkout -b feature/your-feature-name
|
|
```
|
|
|
|
### 2. Make Changes
|
|
|
|
- Follow code style guidelines
|
|
- Write tests for new features
|
|
- Update documentation
|
|
- Add JSDoc comments
|
|
|
|
### 3. Test Your Changes
|
|
|
|
```bash
|
|
pnpm test
|
|
pnpm lint
|
|
```
|
|
|
|
### 4. Commit Changes
|
|
|
|
Use conventional commits:
|
|
|
|
```
|
|
feat: add new wallet type
|
|
fix: resolve address validation bug
|
|
docs: update API documentation
|
|
test: add integration tests
|
|
refactor: extract constants
|
|
```
|
|
|
|
### 5. Push and Create PR
|
|
|
|
```bash
|
|
git push origin feature/your-feature-name
|
|
```
|
|
|
|
## Code Standards
|
|
|
|
- Follow TypeScript best practices
|
|
- Use Prettier for formatting
|
|
- Pass ESLint checks
|
|
- Write comprehensive tests
|
|
- Document public APIs
|
|
|
|
## Pull Request Process
|
|
|
|
1. Update README if needed
|
|
2. Add tests for new features
|
|
3. Ensure all tests pass
|
|
4. Update documentation
|
|
5. Request review
|
|
|
|
## Questions?
|
|
|
|
Open an issue or contact maintainers.
|