# Contributing to Bank Sampah Faperta Thank you for your interest in contributing! This guide will help you get started. --- ## 🤝 Ways to Contribute - **Bug Reports:** Submit detailed bug reports with reproduction steps - **Feature Requests:** Propose new features with use cases - **Code Contributions:** Submit pull requests for bug fixes or features - **Documentation:** Improve or add documentation - **Testing:** Write tests or improve test coverage - **Code Review:** Review pull requests from other contributors --- ## 📋 Before You Start 1. **Check Existing Issues:** Search for existing issues before creating new ones 2. **Discuss Major Changes:** Open an issue to discuss significant changes before coding 3. **Read Documentation:** Familiarize yourself with the codebase structure 4. **Follow Code Standards:** Adhere to the project's coding conventions --- ## 🚀 Getting Started ### 1. Fork and Clone ```bash # Fork the repository on GitHub, then: git clone https://github.com/YOUR_USERNAME/banksampah-faperta.git cd banksampah-faperta # Add upstream remote git remote add upstream https://github.com/jey41/banksampah-faperta.git ``` ### 2. Set Up Development Environment ```bash # Install dependencies composer install npm install # Configure environment cp .env.example .env php artisan key:generate # Setup database touch database/database.sqlite php artisan migrate --seed # Start development server composer run dev ``` ### 3. Create a Branch ```bash # Update your fork git checkout main git pull upstream main # Create feature branch git checkout -b feature/your-feature-name # or for bug fixes git checkout -b bugfix/issue-description ``` --- ## 💻 Development Workflow ### Making Changes 1. **Write Clean Code:** Follow PSR-12 for PHP, ESLint rules for JavaScript 2. **Add Tests:** Write tests for new features or bug fixes 3. **Update Documentation:** Update relevant docs when changing functionality 4. **Commit Regularly:** Make atomic commits with clear messages ### Running Tests ```bash # Run PHP tests php artisan test # Run specific test file php artisan test tests/Feature/DepositTest.php # Run with coverage php artisan test --coverage ``` ### Code Quality Checks ```bash # Format PHP code ./vendor/bin/pint # Check JavaScript formatting npm run lint ``` --- ## 📝 Commit Message Guidelines Follow **Conventional Commits** format: ``` ():