|
| 1 | + |
| 2 | +- Never work directly on `main` |
| 3 | +- Create new features on branches: |
| 4 | + ```bash |
| 5 | + git checkout -b feature/risk-control-agent |
| 6 | + ``` |
| 7 | + |
| 8 | +### 2. Development Process |
| 9 | +1. Start each feature: |
| 10 | + ```bash |
| 11 | + git checkout develop |
| 12 | + git pull |
| 13 | + git checkout -b feature/new-feature |
| 14 | + ``` |
| 15 | + |
| 16 | +2. Work on your code |
| 17 | +3. Commit regularly: |
| 18 | + ```bash |
| 19 | + git add . |
| 20 | + git commit -m "✨ Added new risk control feature" |
| 21 | + ``` |
| 22 | + |
| 23 | +4. Push feature: |
| 24 | + ```bash |
| 25 | + git push origin feature/new-feature |
| 26 | + ``` |
| 27 | + |
| 28 | +5. Create Pull Request on GitHub to merge into `develop` |
| 29 | + |
| 30 | +## 🎯 Best Practices |
| 31 | + |
| 32 | +### Code Organization |
| 33 | +1. Keep modules small and focused |
| 34 | +2. Use clear naming conventions |
| 35 | +3. Document with docstrings |
| 36 | +4. Add print statements for debugging: |
| 37 | + ```python |
| 38 | + print(f"🌙 Moon Dev Debug: Processing trade signal: {signal}") |
| 39 | + ``` |
| 40 | + |
| 41 | +### Git Commits |
| 42 | +- Use emoji prefixes: |
| 43 | + - ✨ New feature |
| 44 | + - 🐛 Bug fix |
| 45 | + - 📚 Documentation |
| 46 | + - ⚡️ Performance |
| 47 | + - 🧪 Tests |
| 48 | + |
| 49 | +### Testing |
| 50 | +1. Write tests for new features |
| 51 | +2. Run tests before commits |
| 52 | +3. Use pytest for testing |
| 53 | + |
| 54 | +## 📝 Development Steps |
| 55 | + |
| 56 | +1. **Setup Phase** |
| 57 | + - [x] Initialize repository |
| 58 | + - [x] Create README |
| 59 | + - [ ] Set up project structure |
| 60 | + - [ ] Create requirements.txt |
| 61 | + |
| 62 | +2. **Core Development** |
| 63 | + - [ ] Build risk control agent |
| 64 | + - [ ] Develop exit strategy agent |
| 65 | + - [ ] Create entry agent |
| 66 | + - [ ] Implement sentiment analysis |
| 67 | + - [ ] Design strategy execution |
| 68 | + |
| 69 | +3. **Testing & Documentation** |
| 70 | + - [ ] Write unit tests |
| 71 | + - [ ] Create usage examples |
| 72 | + - [ ] Document API |
| 73 | + - [ ] Add installation guide |
| 74 | + |
| 75 | +## 🔑 Remember |
| 76 | +- Commit often |
| 77 | +- Use clear commit messages |
| 78 | +- Test before pushing |
| 79 | +- Document as you go |
| 80 | +- Keep security in mind (no API keys!) |
0 commit comments