Skip to content

Add CONTRIBUTING.md with setup guide and project overview#284

Open
AwkCode wants to merge 1 commit intoFunAudioLLM:mainfrom
AwkCode:add-contributing-guide
Open

Add CONTRIBUTING.md with setup guide and project overview#284
AwkCode wants to merge 1 commit intoFunAudioLLM:mainfrom
AwkCode:add-contributing-guide

Conversation

@AwkCode
Copy link

@AwkCode AwkCode commented Mar 2, 2026

Summary

  • Adds a CONTRIBUTING.md to help new contributors get started with the project
  • Includes development environment setup instructions (with CPU-only instructions for users without GPU)
  • Documents the project structure and model architecture at a high level
  • Outlines how to report bugs, submit PRs, and what types of contributions are welcome
  • Includes Docker usage instructions

This repo has 7.6k stars and 167 open issues but no contribution guidelines. This should help onboard new contributors and reduce repetitive setup questions in issues.

Test plan

  • All links point to correct issue templates and documentation
  • Project structure matches actual repository layout
  • Setup instructions verified against existing requirements.txt and codebase

🤖 Generated with Claude Code

Provides contribution guidelines including:
- Development environment setup (with CPU instructions)
- How to report bugs and submit PRs
- Project structure overview
- Model architecture summary (emotion labels, events, languages)
- Docker usage instructions

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant