Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
102 lines (69 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

102 lines (69 loc) · 2.35 KB

Contributing to Apache Mahout (Qumat)

Thank you for your interest in contributing to Apache Mahout!

1. Installation

Prerequisites: Python 3.10 (>=3.10,<3.11), Poetry, Git

Install Poetry

pip install -U poetry

or follow the instructions in the Poetry official documentation.

Clone and Install Dependencies

git clone https://github.com/apache/mahout.git
cd mahout
poetry install --extras dev

Set Up Pre-commit Hooks

poetry run pre-commit install

2. Development Workflow

2.1 Open an Issue

Create a new issue in GitHub and discuss your ideas with the community.

2.2 Make Changes

Create a new branch for your changes:

git checkout -b your-feature-name

Make your changes, then commit (pre-commit hooks will run automatically):

git add .
git commit -m "Description of your changes"
git push

2.3 Test

Run the test suite using pytest:

poetry run pytest

2.4 Pre-commit Checks

Run pre-commit hooks:

poetry run pre-commit run

Or run pre-commit hooks on all files:

poetry run pre-commit run --all-files

2.5 Create a Pull Request

Create a pull request on GitHub. Please follow the pull request template to provide a detailed description of your changes.

3. Project Structure

  • qumat/ - Core library code
  • docs/ - Documentation
  • examples/ - Examples and Jupyter notebooks
  • testing/ - Test files (using pytest)
  • website/ - Website source code (using Jekyll)