Skip to content
This repository was archived by the owner on Sep 22, 2025. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (69 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

77 lines (69 loc) · 2.35 KB
Raw

Contributing to GraphBit

Thank you for your interest in contributing to GraphBit! This guide will help you get started with development and understand our contribution process.

Development Setup

Note

We strongly recommend that you have your own OpenAI and Anthropic API keys in order to contribute.

  1. For any Linux-based distribution, use the command below to install Rust:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  1. Now, clone the GitHub repository:
git clone https://github.com/InfinitiBit/graphbit.git
cd graphbit
  1. Let's compile the Rust binary:
cargo build --release
  1. Then, install Poetry and necessary packages (make sure that you have properly created a virtual environment for Python):
pip install poetry
poetry lock
poetry install
#If you do not want to install the Python dependencies for benchmark, use --with dev
poetry install --with dev
  1. Now, let's create the Python release version:
cd python/
maturin develop --release
  1. If you want to contribute to this package, please install the pre-commit hook:
pre-commit clean
pre-commit install
pre-commit run --all-files

Before you run the pre-commit hook, make sure you have put the relevant keys in your bash/zsh file:

export OPENAI_API_KEY=your_openai_api_key
export ANTHROPIC_API_KEY=your_anthropic_api_key
  1. After making changes to the code, please run the integration tests for both Python and Rust:
cargo test --workspace
pytest .
  1. For PRs, please use the format below for branches:
  • feature/yourbranchname : For feature enhancements
  • doc/yourbranchname : For changes in documentation
  • refactor/yourbranchname : For refactoring any codebase
  • optimize/yourbranchname : For code optimization
  • bugfix/yourbranchname : For bugfixes that require quick patches and do not raise critical issues
  • hotfix/yourbranchname : For hotfixes that require root solutions to problems that raise critical issues

This framework utilizes the following code quality tools:

Rust:

  • clippy: Code linting
  • fmt: Code formatting
  • cargo-audit: Security audits

Python:

  • flake8: Code linting
  • black: Code formatting
  • isort: Import sorting
  • mypy: Type checking
  • bandit: Security checks

Additional Tools:

  • typos: Spell checking
  • hadolint: Dockerfile linting
  • shellcheck: Shell script linting