Skip to content

Development Setup πŸ› οΈ

This guide will help you set up your development environment for contributing to Bazario.

Prerequisites πŸ“‹

  • Python 3.10 or higher 🐍
  • pip (Python package installer) πŸ“¦
  • git 🌿

Setting Up Your Development Environment πŸš€

  1. Clone the repository:

    git clone https://github.com/chessenjoyer17/bazario.git
    cd bazario
    

  2. Create and activate a virtual environment, for example, with uv πŸ—οΈ:

    uv venv
    
    source .venv/bin/activate
    

Development Tools πŸ”§

  • pytest : For running tests βœ…
  • mypy : For static type checking πŸ”
  • ruff : For code linting and formatting🎨

Pre-commit Hooks 🎣

We use pre-commit hooks to ensure code quality. To set up:

  1. Install pre-commit:

    pip install pre-commit
    

  2. Install the git hooks βš“:

    pre-commit install
    

Making Changes πŸ”„

  1. Create a new branch 🌿:

    git checkout -b feature/your-feature-name
    

  2. Make your changes ✏️

  3. Run tests and quality checks βœ…

  4. Commit your changes πŸ’Ύ

  5. Push to your fork πŸš€

  6. Create a Pull Request πŸ“¬

Need Help? πŸ’‘

If you need help or have questions:

  1. Check the documentation πŸ“–

  2. Create an issue 🎫

  3. Reach out to the maintainers πŸ’¬

Happy coding! πŸŽ‰