Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.18 KB

File metadata and controls

52 lines (34 loc) · 1.18 KB

🤝 Contributing to FileDuck

Thank you for your interest in contributing to FileDuck!

Development Setup

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/fileduck.git
  3. Install dependencies: pnpm install
  4. Start development environment: pnpm dev

Code Standards

  • Follow TypeScript best practices
  • Use Prettier for formatting: pnpm format
  • Run linting: pnpm lint
  • Write tests for new features

Commit Messages

Follow Conventional Commits:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation changes
  • chore: Maintenance tasks
  • refactor: Code refactoring
  • test: Adding tests

Example: feat: add WebRTC peer-to-peer transfer

Pull Request Process

  1. Create a feature branch: git checkout -b feat/my-feature
  2. Make your changes
  3. Test thoroughly
  4. Commit with conventional commits
  5. Push to your fork
  6. Open a Pull Request

Security

If you discover a security vulnerability, please email security@fileduck.example instead of opening an issue.

Code of Conduct

Be respectful, inclusive, and collaborative.

Questions?

Open a Discussion or reach out on Discord.