Contributing to Git-Pandas

We welcome contributions to Git-Pandas! Our goal is to make Git repository analysis simple, fast, and accessible to developers interested in data analysis.

Getting Started

  1. Fork the repository on GitHub

  2. Clone your fork locally:

git clone git@github.com:YourLogin/git-pandas.git
cd git-pandas

  1. Create a feature branch:

git checkout -b feature/your-awesome-feature

  1. Make your changes

  2. Submit a pull request

Development Guidelines

Code Style

  • Follow PEP 8 style guide

  • Use 4 spaces for indentation

  • Maximum line length of 88 characters (Black default)

  • Use snake_case for variables and functions

  • Use CamelCase for classes

  • Add docstrings following Google style guide

Documentation

  • Write detailed docstrings for all public APIs

  • Include type hints for function parameters and return values

  • Document exceptions that may be raised

  • Add examples where appropriate

  • Update the documentation for any new features

Testing

  • Write unit tests for new code

  • Maintain or improve test coverage

  • Run tests before submitting PR:

make test
make coverage

API Design Principles

  • Maintain feature parity between Repository and ProjectDirectory

  • Include limit options for memory-intensive functions

  • Keep the API simple and intuitive

  • Consider performance implications

Current Development Focus

High Priority

  • Improve test coverage with proper unit tests

  • Add diff functionality between revisions

  • Enhance documentation with more examples and visualizations

  • Streamline documentation deployment

Recently Completed (v2.5.0)

  • ✅ File-wise bus factor analysis (completed)

  • ✅ Cache management methods (invalidate_cache, get_cache_stats)

  • ✅ Performance documentation and optimization guide

  • ✅ Remote operations (safe_fetch_remote, warm_cache, bulk operations)

  • ✅ Enhanced caching system with timestamps and metadata

Feature Ideas

  • Cross-branch analytics

  • Enhanced verbose logging

  • Language analytics and insights

  • Code complexity metrics

  • Contributor network analysis

Development Setup

  1. Install development dependencies:

make install-dev

  1. Set up pre-commit hooks:

make pre-commit

  1. Run tests:

make test

  1. Build documentation:

make docs

Questions?

  • Open an issue for bug reports or feature requests

  • Join our discussions on GitHub

  • Check existing issues for similar problems

Thank you for contributing to Git-Pandas!