File size: 2,408 Bytes
a7d7463 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 | """Documentation: Contributing Guide"""
# Contributing to Burme-Coder-Max
We welcome contributions! This guide covers how to contribute.
---
## Ways to Contribute
- 🐛 Report bugs
- 💡 Suggest features
- 📝 Improve documentation
- 🔧 Submit code changes
- ✅ Test new features
---
## Development Setup
### 1. Fork and Clone
```bash
git clone https://github.com/YOUR_USERNAME/burme-coder-max.git
cd burme-coder-max
```
### 2. Create Virtual Environment
```bash
python -m venv venv
source venv/bin/activate # Linux/Mac
# or
venv\Scripts\activate # Windows
```
### 3. Install Dependencies
```bash
pip install -e ".[dev]"
```
### 4. Install Pre-commit Hooks
```bash
pre-commit install
```
---
## Making Changes
### 1. Create a Branch
```bash
git checkout -b feature/my-feature
# or
git checkout -b fix/my-bug
```
### 2. Make Your Changes
- Follow existing code style
- Add tests for new features
- Update documentation
### 3. Run Tests
```bash
pytest tests/ -v
```
### 4. Run Linters
```bash
black src/ tests/
mypy src/
```
---
## Code Style
- Follow PEP 8
- Use type hints
- Add docstrings
- Keep functions small and focused
### Example
```python
from typing import List, Optional
def search_knowledge(query: str, category: Optional[str] = None) -> List[dict]:
"""
Search the knowledge base for relevant content.
Args:
query: Search query string
category: Optional category filter
Returns:
List of matching entries
"""
# implementation
pass
```
---
## Commit Messages
Format:
```
type: Short description
Longer explanation if needed.
```
Types:
- `feat:` New feature
- `fix:` Bug fix
- `docs:` Documentation
- `style:` Formatting
- `refactor:` Code restructuring
- `test:` Tests
- `chore:` maintenance
Example:
```
feat: Add particle burst animation
Add celebration effect with customizable particle count.
Fixes #12
```
---
## Pull Request Process
1. Update documentation for new features
2. Add tests
3. Ensure all tests pass
4. Update CHANGELOG.md
5. Submit PR with clear description
---
## Reporting Issues
When reporting bugs:
- Describe the issue clearly
- Steps to reproduce
- Expected vs actual behavior
- Python version and OS
- Error messages
---
## Questions?
- 📧 Email: contact@amkyawdev.com
- 💬 GitHub Discussions
- 🤝 Community Discord
---
Thank you for contributing! 🙏
|