Contributing

Contributing

We welcome contributions from the community!

Development Setup

1. Set up a local Kind cluster:

   kind create cluster --name podex
   

2. Clone the repository:

   git clone https://github.com/Hritikraj8804/podex.git
   cd podex
   

3. Backend setup:

   cd backend
   python -m venv .venv
   source .venv/bin/activate
   pip install -r requirements.txt
   uvicorn main:app --reload
   

4. Frontend setup:

   cd frontend
   npm install
   npm run dev
   

Areas to Contribute

• Unit Tests The codebase needs pytest and Vitest test suites
• Integration Tests API endpoint verification against test clusters
• Documentation Improve guides and API docs
• Features Check the roadmap for in-progress items

Code Style

• Python: Follow PEP 8, lint with ruff
• TypeScript/React: ESLint + Prettier
• Use the existing component patterns and Tailwind classes