Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
123 lines (84 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

123 lines (84 loc) · 2.88 KB

Contributing to GoPlus Security Skills

Thank you for your interest in contributing to GoPlus Security Skills! This document provides guidelines for contributing to this project.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a new branch for your contribution

Project Structure

skills/
├── plugins/                    # Skill plugins
│   ├── building-secure-tokens/
│   ├── building-secure-transactions/
│   └── building-secure-ai-agent/
├── shared/                     # Shared resources
│   ├── mcp-integration/
│   ├── references/
│   └── schemas/
└── mcp-config/                 # MCP configuration examples

Creating a New Skill

1. Choose the Right Plugin

Place your skill under the appropriate plugin directory:

  • building-secure-tokens/ - Token security analysis
  • building-secure-transactions/ - Transaction and address security
  • building-secure-ai-agent/ - AI agent security (Phase 2)

2. Skill Structure

Each skill should follow this structure:

skills/
└── your-skill-name/
    ├── SKILL.md           # Required: Main skill definition
    ├── resources/         # Optional: Reference materials
    ├── workflows/         # Optional: Step-by-step guides
    ├── templates/         # Optional: Code templates
    └── scripts/           # Optional: Helper scripts

3. SKILL.md Format

Your SKILL.md should include:

# Skill Name

Brief description of what this skill does.

## Activation

Keywords or phrases that trigger this skill.

## MCP Tools

List of GoPlus MCP tools this skill uses.

## Workflow

Step-by-step instructions for the AI assistant.

## Output Format

Expected output structure.

Code Style

  • Use clear, descriptive names
  • Include comments for complex logic
  • Follow existing patterns in the codebase

Submitting Changes

Pull Request Process

  1. Ensure your changes follow the project structure
  2. Update documentation if needed
  3. Test your skill with Claude Code
  4. Submit a pull request with a clear description

PR Title Format

Use conventional commit style:

  • feat: Add new phishing detection patterns
  • fix: Correct chain ID mapping for Arbitrum
  • docs: Update installation instructions
  • refactor: Simplify token analysis workflow

PR Description

Include:

  • What the change does
  • Why it's needed
  • How to test it
  • Any breaking changes

Reporting Issues

When reporting issues, please include:

  1. Description of the issue
  2. Steps to reproduce
  3. Expected vs actual behavior
  4. Environment details (Claude Code version, OS)

Questions?

  • Open an issue for questions
  • Check existing issues before creating new ones
  • Join discussions in the Issues section

License

By contributing, you agree that your contributions will be licensed under the Apache-2.0 License.