Skip to content

Latest commit

 

History

History
52 lines (42 loc) · 974 Bytes

CONTRIBUTING.md

File metadata and controls

52 lines (42 loc) · 974 Bytes

🤝 Contributing Guidelines

📝 Recent Updates

  • Added menu-based development workflow
  • Updated project structure guidelines
  • Enhanced testing requirements

🚀 Development Setup

  1. Fork and clone
  2. Create virtual environment
  3. Run python src/menu.py
  4. Select "Core Tools > Requirements Manager"

📋 Development Process

  1. Create feature branch
    git checkout -b feature/your-feature
  2. Make changes
  3. Run tests
  4. Update docs
  5. Submit PR

📋 Coding Standards

  • ✨ Follow PEP 8
  • 📚 Include docstrings
  • ⌨️ Add type hints
  • 🧪 Write unit tests

Development Flow

# Create branch
git checkout -b feature/your-feature

# Make changes
# Run tests
# Update docs

# Submit PR
git push origin feature/your-feature

🛠️ Setup with setup.py

# Clone repository
git clone https://github.com/shaerif/python_tools.git
cd python_tools

# Install using setup.py
python setup.py install