Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (52 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

71 lines (52 loc) · 2.06 KB
Raw

Contributing

We are actively developing Super K-Means and accepting contributions! Any kind of PR is welcome.

These are our current priorities:

Features:

  • Support uint64_t for the assignments. Right now, we are limited to ~4 billion vectors.
  • Support for different datatypes: 64-bit double, 16-bit half, 8-bit uint8 (experimental).
  • Support for out-of-core capabilities.

Improvements:

  • A proper benchmarking framework for development.
  • Regression tests on CI.

Getting Started

  1. Fork the repository on GitHub and create a feature branch:
git checkout -b my-feature
  1. Make your changes.
  2. Run the test suite locally before submitting your PR.
  3. Open a Pull Request (PR) against the main branch.

Important

Let us know in advance if you plan to implement a big feature!

Testing

All PRs must pass the full test suite in CI. Before submitting a PR, you should run tests locally:

# C++ tests
cmake . -DSKMEANS_COMPILE_TESTS=ON
make -j$(nproc) tests
ctest .

# Python bindings tests
source venv/bin/activate # If using a venv
pip install .
pytest python/tests/

Tests are also prone to bugs. If that is the case, please open an Issue.

Submitting a PR

  • Open your PR against the main branch.
  • Make sure your branch is rebased on top of main before submission.
  • Verify that CI passes.
  • Keep PRs focused — small, logical changes are easier to review and merge.

Coding Style

  • Function, Class, and Struct names: PascalCase
  • Variables and Class/Struct member names: snake_case
  • Constants and magic variables: UPPER_SNAKE_CASE
  • Avoid new and delete
  • There is a .clang-format and a .clang-tidy in the project. Make sure to adhere to it. We have provided scripts to check and format the files within the project:
pip install clang-format==18.1.8
./scripts/format_check.sh   # Checks the formatting
./scripts/format.sh         # Fix the formatting
./scripts/tidy_check.sh     # .clang-tidy checks

Communication

  • Use GitHub Issues for bug reports and feature requests.