docs: add AI/ML development setup and knowledge graph overview to CONTRIBUTING.md#841
Open
Atulaics wants to merge 1 commit intoOWASP:mainfrom
Open
docs: add AI/ML development setup and knowledge graph overview to CONTRIBUTING.md#841Atulaics wants to merge 1 commit intoOWASP:mainfrom
Atulaics wants to merge 1 commit intoOWASP:mainfrom
Conversation
…to CONTRIBUTING.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description:
What does this PR do?
Adds a new "Setting Up for AI/ML Development" section to CONTRIBUTING.md covering: additional Python dependencies for AI/embedding components, environment variable setup for Neo4j, how to run the CRE importer locally, and a brief explanation of the OpenCRE graph schema (CRE nodes, Standard nodes, Link types).
Why?
While preparing my GSoC 2026 proposal for the AI-Driven Knowledge Graph Enhancement project, I found this information missing from the contributor guide. New contributors working on AI/embedding components have to piece this together from multiple files.
Testing
Followed all steps on Ubuntu 22.04, Python 3.11. All commands verified working.