Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (23 loc) · 968 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 968 Bytes

Contributing to BiteBuddy

Thank you for considering contributing to BiteBuddy! This document provides guidelines and steps for contributing.

Code of Conduct

Please be respectful and inclusive in your interactions with other contributors.

How to Contribute

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature-name)
  3. Make your changes
  4. Run tests if applicable
  5. Commit your changes (git commit -m 'Add some feature')
  6. Push to the branch (git push origin feature/your-feature-name)
  7. Open a Pull Request

Development Setup

Follow the installation instructions in the README.md file.

Project Structure

  • frontend/ - React frontend application
  • backend/ - Express API server
  • admin/ - Admin panel application

Pull Request Process

  1. Update documentation if needed
  2. Keep pull requests focused on a single change
  3. Maintain code quality and style
  4. Test your changes thoroughly