Development
Contributing to Fresh development
Want to contribute to Fresh? Here's how to set up your development environment.
Prerequisites
- Python 3.12 or higher
- uv (recommended) or pip
- Git
Setup
Clone Repository
git clone https://github.com/nesalia-inc/fresh.git
cd freshInstall Dependencies
# Using uv (recommended)
uv sync
# Or using pip
pip install -e ".[dev]"Install Pre-commit Hooks
pre-commit installDevelopment Commands
Running Tests
# Run all tests
pytest
# Run with coverage
pytest --cov
# Run specific test file
pytest tests/test_commands_list.pyCode Quality
# Lint
ruff check .
# Format
ruff format .
# Type check
mypy src/Project Structure
fresh/
├── src/fresh/ # Main source
│ ├── commands/ # CLI commands
│ ├── scraper/ # Web scraping
│ └── core/ # Core modules
├── tests/ # Test suite
├── docs/ # Documentation
└── pyproject.toml # Project configCoding Standards
- Follow PEP 8
- Add type hints
- Write tests for new features
- Use conventional commits
Submitting Changes
- Fork the repository
- Create a feature branch
- Make your changes
- Run tests and linting
- Submit a PR
Getting Help
- Open an issue on GitHub
- Check existing issues and discussions