Skip to content

Contributing

Guidelines for contributing to WakeBuilder.

Overview

Thank you for your interest in contributing to WakeBuilder! This section provides guidelines and instructions for contributing to the project.

Solo Project

WakeBuilder was developed and is currently maintained by a single developer (Sami RAJICHI). While contributions are welcome, please understand that response times for reviewing PRs and issues may vary.

In This Section

  • Development Setup

    Set up your local development environment.

    Setup Guide

  • Code Style

    Coding standards and formatting guidelines.

    Style Guide

  • Testing

    Writing and running tests.

    Testing Guide

  • Pull Requests

    How to submit changes.

    PR Guide

Ways to Contribute

Bug Reports

Found a bug? Help us fix it:

  1. Check existing issues
  2. Create a new issue with:
  3. Clear title and description
  4. Steps to reproduce
  5. Expected vs. actual behavior
  6. Environment details

Feature Requests

Have an idea? Share it:

  1. Open an issue with the enhancement label
  2. Describe the use case
  3. Suggest implementation if you have ideas

Code Contributions

Ready to code? Great:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

Documentation

Help improve docs:

  • Fix typos or unclear text
  • Add examples
  • Improve explanations
  • Translate (future)

Priority Areas

High Priority

  • Audio Processing: Efficiency improvements
  • Data Augmentation: New techniques
  • Model Optimization: Quantization, pruning
  • Testing: Increase coverage
  • Documentation: Tutorials and examples

Medium Priority

  • Web Interface: UI/UX improvements
  • Multi-language: Non-English wake words
  • Alternative Models: Different base embeddings
  • Deployment: Docker optimization

Low Priority

  • Visualization: Training progress
  • Analytics: Model performance
  • Export Formats: Additional formats
  • Integration Examples: Sample projects

Code of Conduct

By participating, you agree to:

  • Maintain a respectful environment
  • Accept constructive feedback
  • Focus on what's best for the project
  • Be welcoming to newcomers

Recognition

Contributors are recognized in:

  • README.md contributors section
  • CHANGELOG.md for significant changes
  • GitHub contributors page