Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (40 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

60 lines (40 loc) · 1.9 KB
Raw

Contributing to Fun-ASR

Thank you for your interest in contributing to Fun-ASR!

How to Contribute

Reporting Bugs

  1. Check if the issue already exists in Issues
  2. If not, open a new issue with:
    • Your environment (OS, Python, PyTorch, FunASR version)
    • Steps to reproduce
    • Expected vs actual behavior

Resolving Issues

A merged pull request, a green main branch, or an available release does not by itself prove that a reported problem is resolved. Keep user-reported issues open until either:

  • the reporter confirms the fix on the affected workflow; or
  • a maintainer reproduces the original failure, verifies the fix in a publicly available version, records the evidence in the issue, and allows a reasonable feedback window.

When a fix needs a release, link the released version and ask the reporter to retest before closing. Use a waiting-for-feedback label when available instead of treating silence as confirmation.

Suggesting Features

Open a Discussion or Issue describing your use case and proposed solution.

Submitting Code

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature
  3. Make your changes
  4. Test your changes locally
  5. Submit a Pull Request with a clear description

Areas We'd Love Help With

  • Adding support for new languages
  • Improving documentation and examples
  • Performance optimizations
  • Bug fixes and edge case handling
  • Integration examples with popular frameworks

Development Setup

git clone https://github.com/QwenAudio/Fun-ASR.git
cd Fun-ASR
pip install -r requirements.txt

Code Style

  • Follow PEP 8 for Python code
  • Add docstrings for public functions
  • Keep commits atomic and well-described

License

By contributing, you agree that your contributions will be licensed under the Apache-2.0 License.