Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (31 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

43 lines (31 loc) · 1.03 KB

Contributing to WebRTC P2P Transfer

We welcome contributions! Here's how you can help:

Development Setup

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/yourusername/webrtc-p2p-transfer.git
  3. Install dependencies: npm install
  4. Start development server: npm run dev:full

Making Changes

  1. Create a feature branch: git checkout -b feature/your-feature-name
  2. Make your changes
  3. Test thoroughly
  4. Commit with descriptive messages
  5. Push to your fork
  6. Create a Pull Request

Code Style

  • Use meaningful variable names
  • Add comments for complex logic
  • Follow existing code formatting
  • Test on multiple platforms when possible

Testing

  • Test both Web and CLI functionality
  • Verify file transfers work correctly
  • Check error handling
  • Test on different browsers/OS if possible

Pull Request Guidelines

  • Describe what your PR does
  • Include screenshots for UI changes
  • Reference any related issues
  • Ensure all tests pass
  • Keep PRs focused and atomic

Thank you for contributing! 🚀