Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (52 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

71 lines (52 loc) · 1.74 KB

Contributing to xgboost-interp

Thank you for your interest in contributing. This guide will help you get started.

Getting Started

  1. Fork the repository on GitHub to your own account
  2. Clone your fork locally: 
    git clone git@github.com:YOUR_USERNAME/xgboost-interp.git
cd xgboost-interp

Development Setup

  1. Install uv if you haven't already
  2. Install dependencies: 
    uv sync

Making Changes

  1. Create a feature branch from main:

    git checkout -b feature/your-feature-name

  2. Make your changes and test locally by running the examples:

    uv run python xgboost_interp/examples/iris_classification_example.py
uv run python xgboost_interp/examples/california_housing_example.py

  3. Run the tests to make sure everything works:

    uv run pytest tests/

  4. Commit your changes with a clear message:

    git add .
git commit -m "Add feature: description of your changes"

Submitting a Pull Request

  1. Push your branch to your fork:

    git push origin feature/your-feature-name

  2. Open a Pull Request on GitHub against the main branch

  3. Fill out the PR template with:

    • A description of what your PR does
    • The type of change (bug fix, new feature, etc.)
    • Any related issues
    • Confirmation that you've completed the checklist items

Code Style

  • Follow existing code patterns and conventions in the repository
  • Use clear, descriptive variable and function names
  • Add docstrings to new functions and classes
  • Keep changes focused and minimal

Questions?

If you have questions or need help, feel free to open an issue.