Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (38 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

52 lines (38 loc) · 1.24 KB

Contributing to MindTree 🌳

Thank you for your interest in contributing to MindTree! This document provides guidelines for contributing.

🛠️ Development Setup

  1. Fork the repository
  2. Clone your fork locally
  3. Install in development mode:
git clone https://github.com/your-username/MindTree.git
cd MindTree
pip install -e ".[dev]"

📝 Contribution Process

  1. Create a feature branch: git checkout -b feat/your-feature
  2. Make your changes
  3. Add tests for new functionality
  4. Run tests: pytest tests/ -v
  5. Commit with conventional commits format
  6. Push and create a Pull Request

📋 Commit Convention

We follow the Conventional Commits specification:

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation updates
  • refactor: Code refactoring
  • test: Test additions/changes
  • chore: Build/tooling changes

🐛 Reporting Issues

When reporting issues, please include:

  • Python version
  • Operating system
  • Steps to reproduce
  • Expected vs actual behavior
  • Error messages/stack traces

📜 Code Style

  • Follow PEP 8 guidelines
  • Add docstrings to all public functions/classes
  • Keep functions focused and small
  • Maintain zero external dependency policy