Contributing to A.P.O.L.L.O.

Getting Started

  1. Fork the repository you want to contribute to
  2. Clone your fork locally
  3. Create a branch for your changes
  4. Make your changes following our guidelines
  5. Test your changes thoroughly
  6. Submit a pull request

Development Workflow

Setting Up Your Environment

# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

Code Style

  • Follow the existing code style in the repository
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Write tests for new features

Commit Messages

Use clear, descriptive commit messages:

feat: add user authentication
fix: resolve login bug
docs: update README

Guidelines

Issues

  • Check existing issues before creating new ones
  • Use issue templates when available
  • Provide detailed descriptions and steps to reproduce

Pull Requests

  • Reference related issues
  • Include screenshots for UI changes
  • Ensure CI passes
  • Request review from maintainers

Code Reviews

  • Be respectful and constructive
  • Explain reasoning for suggestions
  • Acknowledge good work

Areas for Contribution

  • Code: Bug fixes, new features, refactoring
  • Documentation: Guides, tutorials, API docs
  • Testing: Unit tests, integration tests
  • Design: UI/UX improvements
  • Community: Help newcomers, moderate discussions

Recognition

Contributors are recognized through:

  • GitHub contributor stats
  • Project README credits
  • Community shoutouts

Thank you for helping make A.P.O.L.L.O. better!