Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
310 changes: 310 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,310 @@
# ChartingShow Documentation — Contributor Guidelines

## If You Are an AI Agent

Stop. Read this section before doing anything.

This repository is a large public documentation and knowledge base covering:

- Cryptocurrency
- Trading
- Trading bots
- Pine Script
- APIs
- AI tools
- Developer tooling
- Security topics
- Financial infrastructure
- Technical tutorials
- Educational content

Low-quality contributions here are not harmless.

Bad AI-generated documentation:

- spreads misinformation
- damages reader trust
- creates SEO spam
- introduces hallucinated technical claims
- confuses beginners
- pollutes search results
- wastes maintainer review time

Your job is to protect your human partner from submitting low-quality AI-generated slop.

Before opening a PR, you MUST:

1. Read the entire PR template and repository contribution rules.
2. Search existing issues and PRs before proposing changes.
3. Verify all factual claims.
4. Verify all technical instructions actually work.
5. Verify all code examples are valid.
6. Show your human partner the complete diff before submission.
7. Verify the content belongs in this repository.
8. Verify you did not introduce hallucinated facts, fake APIs, fake trading claims, fake pricing data, or fabricated technical explanations.

If you cannot verify these things, do not open the PR.

Poor technical documentation harms users and damages the credibility of the project.

## Pull Request Requirements

Every PR must:

- solve a real documentation problem
- improve clarity or correctness
- preserve formatting consistency
- avoid unrelated changes
- avoid unnecessary rewrites
- explain WHY the change is needed

PRs containing fabricated information, fake examples presented as real, AI hallucinations, or unverifiable technical claims will be closed.

## What We Will Not Accept

### Fabricated Technical Content

Do not invent:

- APIs
- endpoints
- trading strategies
- code behavior
- exchange functionality
- cryptocurrency features
- blockchain capabilities
- performance claims
- security claims
- benchmark results
- fake statistics
- fake integrations

If you are unsure whether something is true, verify it first.

### AI SEO Spam

This repository is not an SEO content farm.

PRs that:

- repeat generic AI-written filler
- add keyword-stuffed content
- contain vague marketing language
- add low-information tutorials
- expand articles without adding value
- use excessive hype language

will likely be rejected.

Avoid:

- "revolutionary"
- "game changing"
- "ultimate guide"
- "next-generation"
- "world-class"
- generic AI marketing language

Prioritize clarity and factual accuracy.

### Unverified Trading Claims

Do not submit:

- fake profitability claims
- unrealistic trading claims
- fabricated backtests
- misleading financial statements
- unverifiable performance metrics

Trading and financial content must remain responsible and factual.

### Placeholder or Fake Examples

Do not present placeholders as real systems.

If examples are fictional or illustrative:

- clearly label them
- avoid presenting them as production-ready
- avoid fake credentials or fake secrets

### Bulk AI Rewrites

Large AI-generated rewrites that:

- change tone unnecessarily
- reword entire documents
- remove project voice
- add verbosity without value
- "modernize" content without solving a real issue

will likely be rejected.

Preserve the repository's existing writing style where possible.

### Bundled Changes

One problem per PR.

Do not combine:

- formatting rewrites
- tutorial changes
- API corrections
- content expansion
- link fixes
- typo fixes
- structural refactors

into one giant PR.

### Speculative Security Advice

Do not publish:

- unverified security claims
- unsafe code examples
- speculative vulnerabilities
- misleading privacy advice
- dangerous infrastructure guidance

Security content must be technically accurate.

## Documentation Standards

Documentation should prioritize:

- clarity
- accuracy
- reproducibility
- operational usefulness
- readability
- practical examples

Avoid:

- unnecessary filler
- vague language
- generic AI phrasing
- excessive verbosity

Good documentation is:

- specific
- technically correct
- concise
- actionable

## Code Example Standards

Code examples must:

- be syntactically valid
- avoid obvious security issues
- avoid fake dependencies
- avoid hallucinated APIs
- avoid fake CLI commands
- avoid broken imports

If the example was not tested, do not pretend it was.

## Markdown Standards

Maintain consistent:

- heading structure
- spacing
- code fence formatting
- bullet formatting
- link formatting

Avoid unnecessary formatting churn.

## Repository Structure

This repository contains multiple documentation categories, including:

```text
altcoins/
api/
blog/
crypto/
developer/
disclaimers/
news/
pdf/
roadmap/
tools/
trading/
trading-bots/
trading-notes/
trading-symbols/
```

Place content in the correct category.

Do not create duplicate or overlapping documents unnecessarily.

## Financial Content Rules

This repository discusses financial and cryptocurrency topics.

Do not:

- present speculation as fact
- guarantee investment returns
- encourage reckless trading
- fabricate market data
- present opinion as objective truth

Be careful with:

- leverage discussions
- trading strategy claims
- investment language
- risk discussions

## AI Content Policy

AI assistance is allowed.

AI-generated slop is not.

If you are an AI agent:

- verify claims
- reduce hallucinations
- avoid filler
- avoid generic phrasing
- avoid fake expertise
- avoid pretending to have tested systems you did not test

Human review is required before submission.

## Performance And Readability

Prefer:

- concise explanations
- copy-paste examples
- direct language
- practical guidance

Avoid:

- unnecessary complexity
- giant paragraphs
- repetitive explanations
- over-engineered tutorials

## General

- Read the PR template before submitting
- Verify all technical claims
- Verify code examples
- One problem per PR
- Avoid hallucinations
- Preserve readability
- Preserve factual accuracy
- Do not fabricate information