Skip to main content

TradingView Publishing Guidelines Integration

Overview​

This document outlines how to integrate TradingView's House Rules and Script Publishing Rules into our development workflow while maintaining support for both public open-source scripts and invite-only scripts.

TradingView Requirements Summary​

Key Requirements for Public Scripts​

  1. Language Requirements

    • Publication titles must be English-only
    • English must appear first in descriptions (other languages allowed after)
    • UI text must have English translations if non-English

  2. Originality and Usefulness

    • Scripts must be original and add value to the community
    • Avoid rehashing built-ins or public domain code
    • Must justify mashups with clear purpose
    • Closed-source scripts must have unique features requiring protection

  3. Title Requirements

    • Only 7-bit ASCII characters (no emoji)
    • No all caps except abbreviations (BB, RSI, etc.)
    • English only
    • No misleading claims or advertisements

  4. Description Requirements

    • Detailed explanation of originality, functionality, and usage
    • Self-contained (cannot rely on external links)
    • Must substantiate any performance claims
    • Open-source scripts need thorough explanations for non-Pine readers

  5. Chart Requirements

    • Clean chart showing only the script's outputs
    • No unnecessary scripts, drawings, or images
    • Complete symbol/timeframe/indicator information visible
    • No non-standard charts for strategies or signal scripts

  6. Strategy Requirements

    • Realistic account size for average trader
    • Realistic commission and slippage
    • Sustainable risk per trade (≤5-10%)
    • Sufficient sample size (ideally 100+ trades)
    • No lookahead bias in request.security() calls

  7. Open-Source Reuse Requirements

    • Must credit original authors
    • Must make significant improvements (not just style changes)
    • Must publish as open-source unless explicit permission or public domain
    • TradingView built-ins and library scripts are considered public domain

Workflow Integration Strategy​

1. Publication Type Detection​

We'll enhance our workflow to automatically detect and handle different publication types:

  • Public Open-Source: Full compliance with TradingView rules
  • Public Invite-Only: Compliance + vendor requirements
  • Private: Minimal validation (for testing/drafts)

2. Enhanced Validation Pipeline​

Pre-Publication Validation​

  • Validate title format (ASCII-only, English, no all-caps)
  • Check description completeness and compliance
  • Verify chart cleanliness
  • Validate strategy settings (if applicable)
  • Check for original content vs. rehashed code

Content Quality Checks​

  • Ensure English translations for non-English UI elements
  • Validate technical explanations are self-contained
  • Check for substantiated performance claims
  • Verify proper attribution for any reused code

3. Template Updates​

Enhanced TradingView Description Template​

  • Compliance-focused sections
  • Built-in validation prompts
  • Separate templates for open-source vs. invite-only

README Template Updates​

  • Clear publication type designation
  • Compliance checklist integration
  • Attribution section for code reuse

4. Automated Compliance Tools​

Title Validator​

  • ASCII character validation
  • Capitalization checks
  • English-only verification

Description Analyzer​

  • Completeness scoring
  • Self-containment validation
  • Performance claim detection

Chart Validator​

  • Clean chart verification prompts
  • Standard chart type confirmation
  • Visual element documentation

Implementation Plan​

Phase 1: Core Infrastructure (Immediate)​

  1. Create Publication Type System

    • Add publication type detection to workflow
    • Create type-specific validation rules
    • Update existing scripts to handle multiple types

  2. Enhance Validation Tools

    • Add TradingView compliance checks to existing validators
    • Create title and description validators
    • Integrate with pre-publication workflow

  3. Update Templates

    • Create compliance-focused TradingView description templates
    • Add attribution and originality sections
    • Include built-in validation prompts

Phase 2: Advanced Features (Next Sprint)​

  1. Smart Content Analysis

    • Description completeness scoring
    • Performance claim detection
    • Originality assessment prompts

  2. Enhanced Documentation

    • Compliance guidelines integration
    • Best practices documentation
    • Examples of compliant vs. non-compliant content

  3. Workflow Automation

    • Automated compliance report generation
    • Pre-publication checklist automation
    • Publication type-specific workflows

Phase 3: Quality Assurance (Ongoing)​

  1. Continuous Monitoring

    • Regular compliance audits
    • Community feedback integration
    • Rule update monitoring

  2. Training and Documentation

    • Developer training materials
    • Compliance best practices guide
    • Common pitfalls documentation

File Structure Updates​

docs/
├── TradingView_Publishing_Guidelines.md (this file)
├── TradingView_Compliance_Checklist.md (new)
└── Publishing_Type_Guide.md (new)

templates/
├── tradingview-description-opensource-template.txt (new)
├── tradingview-description-inviteonly-template.txt (new)
└── compliance-checklist-template.md (new)

tools/
├── validate-tv-compliance.sh (new)
├── title-validator.sh (new)
└── description-analyzer.sh (new)

Migration Path​

For Existing Scripts​

  1. Audit Current Scripts

    • Review all existing indicators for compliance
    • Identify potential issues
    • Prioritize fixes based on publication importance

  2. Gradual Updates

    • Update during normal maintenance cycles
    • Focus on high-priority public scripts first
    • Maintain backward compatibility

  3. Documentation Updates

    • Enhance descriptions for compliance
    • Add proper attributions where needed
    • Improve technical explanations

For New Scripts​

  1. Compliance by Design

    • Use new templates from start
    • Built-in validation throughout development
    • Publication type consideration early in planning

  2. Automated Workflows

    • New scripts automatically use enhanced validation
    • Publication type detection from project creation
    • Continuous compliance monitoring

Key Benefits​

  1. Maintained Functionality

    • All existing workflows continue to work
    • No breaking changes to current scripts
    • Gradual enhancement approach

  2. Enhanced Quality

    • Better descriptions and documentation
    • Higher likelihood of TradingView approval
    • Professional presentation standards

  3. Risk Mitigation

    • Reduced chance of script rejection
    • Clear compliance documentation
    • Proactive issue identification

  4. Flexibility

    • Support for all publication types
    • Customizable validation levels
    • Easy workflow switching

Next Steps​

  1. Review and approve this integration plan
  2. Begin Phase 1 implementation
  3. Test with existing MACDRSI+ indicator
  4. Gather feedback and iterate
  5. Roll out to all projects

This approach ensures we meet TradingView's requirements while maintaining the flexibility and functionality of our current workflow system.