Local changes: Updated model training, removed debug instrumentation, and configuration improvements
This commit is contained in:
40
docs/developer/README.md
Normal file
40
docs/developer/README.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Developer Guide
|
||||
|
||||
Welcome to the Crypto Trader developer guide. This guide will help you set up a development environment, understand the codebase, and contribute to the project.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [Development Setup](setup.md) - Setting up your development environment
|
||||
2. [Architecture Overview](architecture.md) - System architecture and design
|
||||
3. [Coding Standards](coding_standards.md) - Code style and conventions
|
||||
4. [Adding Exchanges](adding_exchanges.md) - How to add new exchange adapters
|
||||
5. [Creating Strategies](creating_strategies.md) - Strategy development guide
|
||||
6. [Testing](testing.md) - Testing guidelines and practices
|
||||
7. [Contributing](contributing.md) - Contribution guidelines
|
||||
8. [Release Process](release_process.md) - Release and deployment process
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. [Set up development environment](setup.md)
|
||||
2. [Review architecture](architecture.md)
|
||||
3. [Read coding standards](coding_standards.md)
|
||||
4. [Run tests](testing.md#running-tests)
|
||||
5. [Make your first contribution](contributing.md)
|
||||
|
||||
## Development Workflow
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch
|
||||
3. Make your changes
|
||||
4. Write/update tests
|
||||
5. Ensure all tests pass
|
||||
6. Update documentation
|
||||
7. Submit a pull request
|
||||
|
||||
## Getting Help
|
||||
|
||||
- Review the [API Documentation](../api/index.html)
|
||||
- Check existing issues and pull requests
|
||||
- Ask questions in discussions
|
||||
- Review code examples in the codebase
|
||||
|
||||
Reference in New Issue
Block a user