Skip to content

Commit f974009

Browse files
Add CONTRIBUTING.md
1 parent 1a57ec1 commit f974009

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# 🤝 Contributing to UnityNeuroSpeech
2+
3+
Thanks for your interest in improving UnityNeuroSpeech!
4+
5+
---
6+
7+
## 🛠️ How to Contribute
8+
9+
Whether it's a bug fix, new feature, doc update, or crazy idea — you're welcome here!
10+
11+
Here’s what to do:
12+
13+
1. Fork the repo.
14+
2. Create a branch and make your changes.
15+
3. Test your changes inside Unity. Make sure everything runs as expected.
16+
4. Open a Pull Request and describe what you did.
17+
18+
---
19+
20+
## ✨ Style & Guidelines
21+
22+
- Write **clean, readable, and well-commented** code.
23+
- Follow **Unity C# best practices** (naming, null checks, serialization, etc).
24+
- Use **English** for all code comments, logs, and docs.
25+
- Test your changes — especially **if you're modifying the Python TTS server**.
26+
- Don't break existing features — unless you're upgrading them with care 😄
27+
28+
---
29+
30+
## 📜 Licensing
31+
32+
Make sure **you don’t include anything with a restrictive license** (especially if it’s not MIT-compatible).
33+
Only submit code, models, or content that’s allowed for open source use.
34+
35+
---
36+
37+
## 🐞 Found a Bug?
38+
39+
Open an [issue](https://github.com/HardCodeDev777/UnityNeuroSpeech/issues) and describe:
40+
- What happened?
41+
- How to reproduce it?
42+
- Any logs or screenshots (if helpful)
43+
44+
---
45+
46+
**Let’s make AI-in-Unity great together 🤝**

0 commit comments

Comments
 (0)