Contributing Guidelines

Thank you for your interest in contributing to Crypto Trader!

How to Contribute

Reporting Bugs

Check if the bug has already been reported
Create a new issue with:
- Clear description
- Steps to reproduce
- Expected vs actual behavior
- System information
- Log files (if applicable)

Suggesting Features

Check if the feature has been suggested
Create a feature request with:
- Use case description
- Proposed solution
- Benefits
- Implementation considerations

Code Contributions

Fork the repository
Create a feature branch:
```
git checkout -b feature/my-feature
```
Make your changes:
- Follow coding standards
- Write tests
- Update documentation
Run tests:
```
pytest
```

Commit changes:

git commit -m "feat(module): add new feature"

Push to your fork:
```
git push origin feature/my-feature
```
Create a pull request

Pull Request Process

Before Submitting

Code follows style guide
Tests are included and passing
Documentation is updated
No new warnings or errors
Coverage is maintained

Pull Request Template

## Description
Brief description of changes

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update

## Testing
How was this tested?

## Checklist
- [ ] Code follows style guide
- [ ] Tests added/updated
- [ ] Documentation updated
- [ ] No breaking changes (or documented)

Code Review

All pull requests require review:

At least one approval required
Address review comments
Keep PR focused and small when possible
Respond to feedback promptly

Development Setup

See Development Setup for environment setup.

Coding Standards

See Coding Standards for detailed guidelines.

Questions?

Open a discussion
Check existing issues
Review documentation
Ask in comments

Recognition

Contributors will be recognized in:

CONTRIBUTORS.md
Release notes
Project documentation

Thank you for contributing!

2.1 KiB Raw Blame History