53 lines
1.0 KiB
Markdown
53 lines
1.0 KiB
Markdown
# Contributing to OpenCode Filter
|
|
|
|
Thank you for your interest in contributing! 🎉
|
|
|
|
## How to Contribute
|
|
|
|
1. **Fork the repository**
|
|
2. **Create a feature branch**: `git checkout -b feature/my-feature`
|
|
3. **Make your changes**
|
|
4. **Run tests**: `npm test`
|
|
5. **Commit your changes**: `git commit -m "feat: add new feature"`
|
|
6. **Push to your fork**: `git push origin feature/my-feature`
|
|
7. **Create a Pull Request**
|
|
|
|
## Development Setup
|
|
|
|
```bash
|
|
# Clone your fork
|
|
git clone https://github.com/YOUR_ORG/opencode-filter.git
|
|
cd opencode-filter
|
|
|
|
# Install dependencies
|
|
npm install
|
|
|
|
# Build
|
|
npm run build
|
|
|
|
# Run tests
|
|
npm test
|
|
```
|
|
|
|
## Code Style
|
|
|
|
- Use TypeScript
|
|
- Follow existing code patterns
|
|
- Write tests for new features
|
|
- Keep functions small and focused
|
|
|
|
## Commit Messages
|
|
|
|
We use conventional commits:
|
|
|
|
- `feat:` New feature
|
|
- `fix:` Bug fix
|
|
- `docs:` Documentation changes
|
|
- `test:` Test changes
|
|
- `refactor:` Code refactoring
|
|
- `chore:` Build/tooling changes
|
|
|
|
## Questions?
|
|
|
|
Open an issue or contact the maintainers.
|