# Contributing to HelmView Thank you for your interest in contributing to HelmView! This document provides guidelines and instructions for contributing. ## 🎯 Ways to Contribute - 🐛 Report bugs - 💡 Suggest new features - 📝 Improve documentation - 🔧 Submit bug fixes - ✨ Add new features - 🎨 Improve UI/UX - 🧪 Write tests - 🌍 Translate (future) ## 🚀 Getting Started ### Prerequisites - Git - Docker & Docker Compose - Node.js 18+ (for local development) - Python 3.11+ (for local development) ### Fork and Clone ```bash # Fork the repository on GitHub # Then clone your fork git clone https://github.com/YOUR_USERNAME/helmview.git cd helmview ``` ### Development Setup ```bash # Start the application docker-compose up --build # Or run locally # Backend cd backend python -m venv venv source venv/bin/activate # Windows: venv\Scripts\activate pip install -r requirements.txt uvicorn main:app --reload # Frontend (separate terminal) cd frontend npm install npm run dev ``` ## 📋 Development Workflow ### 1. Create a Branch ```bash git checkout -b feature/my-new-feature # or git checkout -b fix/bug-description ``` ### Branch Naming - `feature/` - New features - `fix/` - Bug fixes - `docs/` - Documentation changes - `refactor/` - Code refactoring - `test/` - Test additions - `chore/` - Maintenance tasks ### 2. Make Changes #### Code Style **Backend (Python)** - Follow PEP 8 - Use type hints - Add docstrings for functions - Keep functions focused and small **Frontend (JavaScript)** - Use modern ES6+ syntax - Follow React best practices - Use functional components with hooks - Keep components focused and reusable #### Commit Messages Follow the conventional commits format: ``` ():