Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (57 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

83 lines (57 loc) · 1.95 KB
Raw

Contributing to NetGraph-Core

This document provides guidelines for setting up your development environment and submitting contributions.

Development Setup

NetGraph-Core is a hybrid C++/Python project. You will need:

  • Python 3.11+
  • C++20 compatible compiler (GCC 10+, Clang 12+, MSVC 2019+)
  • CMake 3.23+
  • Ninja (recommended)

1. Clone the repository

git clone https://github.com/networmix/NetGraph-Core.git
cd NetGraph-Core

2. Create a virtual environment and install dependencies

We use a Makefile to simplify development tasks.

make dev
source venv/bin/activate

This will:

  • Create a virtual environment in ./venv
  • Install all development dependencies
  • Install pre-commit hooks

Workflow

Running Tests

Run all checks (linting + C++ tests + Python tests):

make check

Run specific test suites:

make cpp-test   # C++ tests (GoogleTest)
make test       # Python tests (pytest)

Code Style

  • Python: We use ruff for linting and formatting, and pyright for static type checking.
  • C++: We follow standard C++20 practices.

Auto-fix Python formatting:

make format

Release Process

Releases are automated via GitHub Actions when a new tag is pushed.

  1. Move the pending notes into a new ## [X.Y.Z] - YYYY-MM-DD section in CHANGELOG.md, dated the day you tag. Mark anything that breaks consumers as BREAKING.

  2. Bump version in pyproject.toml to the same X.Y.Z. CI does not cross-check the tag against this value, so a mismatch publishes the wrong version silently.

  3. Commit and push.

  4. Create and push a matching tag:

    git tag v0.8.0
git push origin v0.8.0

  5. The CI pipeline builds wheels and the sdist, tests them, and publishes to PyPI via Trusted Publishing. make publish / make publish-test upload whatever is in your local dist/ and are for Test PyPI or emergencies only -- real releases go through the tag.