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.
|