Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
113 lines (85 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

113 lines (85 loc) · 2.47 KB

Contributing to WhatsApp Desktop Linux

Thank you for your interest in contributing! 🎉

🚀 Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally: 
    git clone https://github.com/YOUR-USERNAME/whatsapp-desktop-linux.git
cd whatsapp-desktop-linux
  3. Install dependencies: 
    npm install
  4. Create a branch for your changes: 
    git checkout -b feature/your-feature-name

🛠️ Development

Running in Development Mode

npm start

Building AppImage

npm run build-linux

Testing Changes

  • Test the app functionality thoroughly
  • Verify keyboard shortcuts work
  • Check system tray integration
  • Test on different Linux distributions if possible

📝 Guidelines

Code Style

  • Follow existing code formatting
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions focused and small

Commit Messages

  • Use clear, descriptive commit messages
  • Start with a verb (Add, Fix, Update, Remove, etc.)
  • Reference issues when applicable

Example:

Add support for notification sound toggle

Fixes #42

Pull Request Process

  1. Update documentation if you're adding features
  2. Test thoroughly - ensure no regressions
  3. Update README.md if needed
  4. Create pull request with:
    • Clear title and description
    • Reference any related issues
    • Screenshots/videos for UI changes

🐛 Bug Reports

When reporting bugs, please include:

  • Operating system and version
  • Electron version (from Help → About)
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots if applicable
  • Console logs (if available)

💡 Feature Requests

For feature requests:

  • Check if similar request exists
  • Explain the use case
  • Describe the proposed solution
  • Consider if it fits the project scope

🔒 Security Issues

Please DO NOT create public issues for security vulnerabilities. Instead, email directly to: security@example.com

📄 License

By contributing, you agree that your contributions will be licensed under the MIT License.

🤝 Code of Conduct

  • Be respectful and inclusive
  • Focus on constructive feedback
  • Help others learn and grow
  • Maintain a welcoming environment

❓ Questions?

Feel free to ask questions by:

  • Opening a discussion
  • Creating an issue with the "question" label
  • Reaching out to maintainers

Thank you for making WhatsApp Desktop Linux better! 🚀