AudioForge / CONTRIBUTING.md
OnyxlMunkey's picture
c618549
# Contributing to AudioForge
Thank you for your interest in contributing to AudioForge!
## Development Setup
### Backend
```bash
cd backend
uv venv
source .venv/bin/activate # or `.venv\Scripts\activate` on Windows
uv pip install -e ".[dev]"
```
### Frontend
```bash
cd frontend
pnpm install
pnpm dev
```
## Running Tests
### Backend
```bash
cd backend
pytest tests/ -v
```
### Frontend
```bash
cd frontend
pnpm test
```
## Code Style
- Backend: Black + Ruff + mypy
- Frontend: ESLint + Prettier (via Next.js)
Run formatters:
```bash
# Backend
make format
# Frontend
pnpm lint --fix
```
## Architecture
- **Backend**: FastAPI with async/await patterns
- **Frontend**: Next.js 14+ with App Router
- **Database**: PostgreSQL with SQLAlchemy async
- **Caching**: Redis
- **ML Models**: MusicGen, Bark
## Pull Request Process
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Ensure all tests pass
6. Submit a PR with a clear description