mirror of
https://github.com/Xe138/AI-Trader.git
synced 2026-04-02 09:37:23 -04:00
Bill
6f19c9dbe9
Update developer documentation files: - CONTRIBUTING.md: Update title to AI-Trader-Server - development-setup.md: Update git clone URL from github.com/Xe138/AI-Trader to github.com/Xe138/AI-Trader-Server - testing.md: Update title to reference AI-Trader-Server Part of Phase 3: Developer & Deployment Documentation
49 lines
910 B
Markdown
49 lines
910 B
Markdown
# Contributing to AI-Trader-Server
|
|
|
|
Guidelines for contributing to the project.
|
|
|
|
---
|
|
|
|
## Development Setup
|
|
|
|
See [development-setup.md](development-setup.md)
|
|
|
|
---
|
|
|
|
## Pull Request Process
|
|
|
|
1. Fork the repository
|
|
2. Create feature branch: `git checkout -b feature/my-feature`
|
|
3. Make changes
|
|
4. Run tests: `pytest tests/`
|
|
5. Update documentation
|
|
6. Commit: `git commit -m "Add feature: description"`
|
|
7. Push: `git push origin feature/my-feature`
|
|
8. Create Pull Request
|
|
|
|
---
|
|
|
|
## Code Style
|
|
|
|
- Follow PEP 8 for Python
|
|
- Use type hints
|
|
- Add docstrings to public functions
|
|
- Keep functions focused and small
|
|
|
|
---
|
|
|
|
## Testing Requirements
|
|
|
|
- Unit tests for new functionality
|
|
- Integration tests for API changes
|
|
- Maintain test coverage >80%
|
|
|
|
---
|
|
|
|
## Documentation
|
|
|
|
- Update README.md for new features
|
|
- Add entries to CHANGELOG.md
|
|
- Update API_REFERENCE.md for endpoint changes
|
|
- Include examples in relevant guides
|