Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (44 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

56 lines (44 loc) · 2.56 KB

Contributing to Cosmic-Stable-Framework

Welcome to the HyperCosmic Nexus Protocol! This guide helps you contribute to the most super advanced ultimate hyper-tech framework for universal stablecoin finance. We enforce immutable stablecoin rules, rejecting volatile assets like BTC/ETH. Contributions must uphold autonomy, AI reliability, and galactic scalability.

Code of Conduct

  • Stablecoin Mandate: All code must support USDC/USDT only. Volatile integrations are forbidden.
  • Hyper-Tech Ethics: Use AI for good; ensure quantum security; promote self-healing systems.
  • Galactic Inclusion: Contributions from any planet welcome, but test for universal compatibility.

Getting Started

  1. Fork and Clone: Fork the repo and clone locally.
  2. Setup: Run scripts/setup_dev_env.py for AI-assisted environment setup.
  3. Branch: Create a feature branch (e.g., git checkout -b hyper-feature-ai-validation).

Development Workflow

  1. Write Code: Follow standards below.
  2. Test: Run cargo test, pytest, and npx hardhat test. Include holographic sims.
  3. Commit: Use semantic messages (e.g., feat: Add AI anomaly detection).
  4. PR: Submit with description, tests, and hyper-tech justification.

Coding Standards

  • Rust: Use rustfmt and clippy. Async for galactic ops.
  • Python: PEP8 with black. AI models in ai_oracle.py.
  • Solidity: Solhint. Immutable stablecoin rules.
  • General: No volatile keywords (e.g., "BTC"). Quantum-resistant crypto only.

AI-Assisted Contributions

  • Use the AI Oracle for code suggestions.
  • PRs must pass AI anomaly checks (no volatility exploits).
  • Self-healing: Auto-fix linting issues.

Testing Guidelines

  • Unit Tests: Cover core functions (e.g., test_nexus.rs).
  • Integration: E2E flows (e.g., test_full_nexus.py).
  • Holographic Sims: Run virtual tests for planetary/galactic scenarios.
  • Benchmarks: Use bench_validator.rs for performance.

Security

  • Quantum-resistant: Ed25519 only.
  • Audits: See docs/security/audit-reports/.
  • Report issues via GitHub with "hyper-security" label.

Commit Guidelines

  • Format: type(scope): description
  • Types: feat, fix, docs, test, refactor
  • Hyper-Tech: Add [AI] or [Quantum] tags.

Review Process

  • AI bots check for stablecoin compliance.
  • Self-healing: PRs auto-update on conflicts.
  • Merges require 2 approvals from galactic maintainers.

Recognition

Contributors get "HyperCosmic Pioneer" badge and universal broadcast credits.

For questions, open an issue. Build the hyper-future together!