saemstunes commited on
Commit
d6b0591
·
verified ·
1 Parent(s): b68b21b

Create CONTRIBUTING.md

Browse files
Files changed (1) hide show
  1. CONTRIBUTING.md +30 -0
CONTRIBUTING.md ADDED
@@ -0,0 +1,30 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Contributing to Saem's Tunes AI
2
+
3
+ We love your input! We want to make contributing to Saem's Tunes AI as easy and transparent as possible.
4
+
5
+ ## Development Process
6
+
7
+ 1. Fork the repo and create your branch from `main`
8
+ 2. Make your changes
9
+ 3. Add tests for new functionality
10
+ 4. Ensure all tests pass
11
+ 5. Submit a pull request
12
+
13
+ ## Code Style
14
+
15
+ - Use Black for code formatting
16
+ - Follow PEP 8 guidelines
17
+ - Write type hints for all functions
18
+ - Include docstrings for public methods
19
+
20
+ ## Testing
21
+
22
+ ```bash
23
+ # Run all tests
24
+ pytest
25
+
26
+ # Run with coverage
27
+ pytest --cov=src
28
+
29
+ # Run specific test file
30
+ pytest tests/test_ai_system.py