feat: add comprehensive development guide for AI agents #1354
Conversation
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
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Adds essential development documentation for Claude Code usage including: - Required reading list with all essential project documents - Complete development guide with build, test, and lint commands - Detailed architecture overview of plugin system and veles sub-library - Issue creation workflow with research and structured templates - Issue completion workflow with PR creation and quality assurance - Create CLAUDE.md with four main sections - Document plugin locations (extractors, detectors, enrichers, annotators) - Include practical GitHub CLI commands and examples - Add safety measures for branch management and code review process 🤖 Generated with [Claude Code](https://claude.ai/code) Signed-off-by: Yousef Alowayed <[email protected]>
alowayed
force-pushed
the
feature/add-claude-md
branch
from
6c6ea21 to
fb932e0
Compare
Remove Co-Authored-By: Claude line from commit message examples to prevent CLA issues in future contributions. 🤖 Generated with [Claude Code](https://claude.ai/code) Signed-off-by: Yousef Alowayed <[email protected]>
Restructure documentation to support multiple AI agents: - Move content from CLAUDE.md to generic AGENT.md - Update title to 'AI Agents' instead of 'Claude' specific - Create symlinks: CLAUDE.md and GEMINI.md both point to AGENT.md - Enables single source of truth for all AI coding assistants - Symlinks work cross-platform including Windows 🤖 Generated with [Claude Code](https://claude.ai/code) Signed-off-by: Yousef Alowayed <[email protected]>
alowayed
changed the title
Replace Claude-specific references with flexible agent pattern: - Change from 'Generated with [Claude Code](https://claude.ai/code)' - To generic pattern: 'Generated with [{agent name}]({website})' - Allows any AI agent to use their preferred attribution format - Automatically applies to all symlinked files (CLAUDE.md, GEMINI.md) 🤖 Generated with [Claude Code](https://claude.ai/code) Signed-off-by: Yousef Alowayed <[email protected]>
Expand Architecture Overview with detailed veles information: - Core architecture and streaming detection engine - Secret detection process with chunk handling - Complete list of available secret types categorized - Step-by-step guide for adding new secret types - Integration points with SCALIBR extractors and enrichers - Technical details on DetectionEngine and ValidationEngine Provides developers with clear understanding of veles capabilities and practical guidance for extending secret detection functionality. 🤖 Generated with [Claude Code](https://claude.ai/code) Signed-off-by: Yousef Alowayed <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds comprehensive development documentation for AI coding assistants working with the OSV-SCALIBR codebase.
Changes
Structure
Testing
This documentation will help AI coding assistants effectively navigate and contribute to the OSV-SCALIBR project by providing clear guidance on project structure, development workflows, and best practices.
🤖 Generated with Claude Code