Thank you for considering contributing to the project. Contributions are always welcome!
Please check the issue tracker to see whether there is an issue you would like to work on or whether it has already been resolved.
- Open an issue on the issue tracker.
- Include steps to reproduce, expected behavior, actual behavior, environment details, and relevant logs or screenshots.
- Open an issue on the issue tracker.
- Provide the feature goal, expected output, and why it benefits the showcase applications.
- Make sure relevant tests and format checks pass before submitting a pull request.
- Write a clear description of the behavior change and the reason for it.
Important
If you use an AI-assisted coding tool like Claude Code or Codex, make sure it follows the instructions in the root AGENTS.md file.
The repository is organized around four showcase applications:
rust/graphrag-agent: GraphRAG application showcasing vector search, full-text search, and hybrid graph expansion.rust/code-explorer: Rust source code navigator illustrating structural graph analysis (PageRank, components, shortest path) on code syntax trees.python/fraud: Cypher-based fraud pattern detection over a simulated transaction stream.python/recommendation: Hybrid friend-of-friend and content recommendation system.
Keep application-specific logic inside the respective subdirectories. Use the top-level Makefile to orchestrate builds, tests, linting, and runs.
- Use standard formatting for both Rust (
cargo fmt) and Python (ruff format). - Keep changes small and focused.
- Ensure all tests pass.
make test# GraphRAG
make demo-grag
# Code Explorer
make demo-code-exp
# Fraud Detection Stream
make demo-fraud
# Social Recommendations
make demo-recommendmake help