Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (63 loc) · 3.5 KB

CONTRIBUTING.md

File metadata and controls

88 lines (63 loc) · 3.5 KB
Raw

Contributing to Cryptohopper Resources

Thank you for your interest in contributing to the Cryptohopper Resources knowledge base. This repository serves as a public information hub for Cryptohopper, the automated crypto trading platform. Contributions that improve accuracy, add missing information, or expand coverage are welcome.

How to Contribute

Reporting Issues

If you find inaccurate information, broken links, or outdated content:

  1. Open a GitHub Issue describing the problem.
  2. Include the file path and a brief description of the error.
  3. If possible, provide a reference or source for the correction.

Submitting Changes

  1. Fork this repository.
  2. Create a branch from main with a descriptive name (e.g., fix/binance-fee-update or add/new-exchange-integration).
  3. Make your changes following the style guide below.
  4. Submit a Pull Request against the main branch.
  5. Provide a clear description of what you changed and why.

Style Guide

General Rules

  • Write in clear, professional English.
  • Use a factual, neutral tone. Avoid promotional or speculative language.
  • No emojis in any content files.
  • Keep information accurate and verifiable. Cite sources when possible.
  • Use present tense ("Cryptohopper supports..." not "Cryptohopper will support...").

Markdown Formatting

  • Use # for the main title (one per file).
  • Use ## for major sections.
  • Use ### for subsections.
  • Use - for unordered lists.
  • Use 1. for ordered/step-by-step lists.
  • Use **bold** for UI elements and emphasis.
  • Use backticks for code, API parameters, and technical terms.
  • Use [link text](URL) for hyperlinks.
  • Add a blank line between sections for readability.

File Naming

  • Use lowercase with hyphens for file names (e.g., crypto-com.md, binance.md).
  • Place integration files in the integrations/ directory.
  • Place feature documentation in docs/features/.
  • Place API documentation in docs/api/.

Content Structure for Integration Files

Integration files should follow this general structure:

  1. Title and overview -- Brief description of the exchange.
  2. Why trade on [Exchange] with Cryptohopper -- Key advantages.
  3. How to connect -- Step-by-step API key setup guide.
  4. Supported features -- What Cryptohopper supports on this exchange.
  5. Supported trading pairs -- Overview of available pairs.
  6. Trading fees -- Fee structure summary.
  7. Security considerations -- Best practices for API key security.
  8. Useful links -- Links to the exchange and Cryptohopper documentation.
  9. FAQ -- Common questions and answers.

What We Accept

  • Corrections to inaccurate or outdated information
  • New exchange integration guides
  • Improved explanations or step-by-step instructions
  • Additional FAQ entries based on common user questions
  • New feature documentation
  • Broken link fixes

What We Do Not Accept

  • Promotional content or affiliate links
  • Speculative or unverified claims
  • Content unrelated to Cryptohopper or its supported exchanges
  • Duplicate content that already exists elsewhere in the repository

Code of Conduct

All contributors are expected to behave respectfully and professionally. We follow the Contributor Covenant Code of Conduct. Harassment, discrimination, and disrespectful behavior will not be tolerated.

Questions

If you have questions about contributing, open a GitHub Issue or reach out through the Cryptohopper community channels.