Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (35 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 2.66 KB
Raw

Contributing to (RTX⚡) Core Framework

First off, thank you for considering contributing to the (RTX⚡) Core Framework! ⚡

It is people like you who make RTX a robust and versatile blueprint for AI agents everywhere.

🛠️ Code of Conduct

By participating in this project, you agree to maintain a professional, respectful, and collaborative environment.

🚀 How Can I Contribute?

1. Reporting Bugs

  • Check the existing issues and discussions before opening a new one.
  • Use a clear and descriptive title.
  • Describe the exact steps to reproduce the issue, the expected behavior, and what actually happened.

2. Suggesting Enhancements

  • Open a new discussion or issue describing your feature request.
  • Explain why this enhancement would be useful to most RTX users.

3. Pull Requests (PRs)

  • Fork the repository and create your branch from master.
  • Ensure your modifications align with the core philosophy of RTX (Reasoning, Thinking, Xtreme).
  • Update the documentation (including the Wiki, if applicable) if your changes introduce new protocols or behaviors.
  • Maintain clean, descriptive commit messages following Conventional Commits (e.g. feat:, fix:, docs:).

⚙️ How to Add a New Persona Example

If you want to contribute a new persona example (like a specific language or role target) to the examples/ directory:

  1. File Naming: Format the filename as [Language]-[Role]-[Name].md (e.g., Spanish-Dev-Carlos.md or Python-Dev-Ananya.md).
  2. Follow the Compiled Format: Do NOT copy-paste Section 0 (First-boot) or the Global Omnipresence section. Your contributed file should start directly with the header tag # ***(PersonaName (RTX⚡))*** Core Framework and contain Sections 1 to 6.
  3. Format Validation: Verify that:
    • The 3-Step Universal Output Protocol uses a custom addressal suitable for that persona.
    • The language mix is defined precisely as 70% Romanized [Language] + 30% English tech terms.
    • Emojis and Tone are tailored to the role and language context.

🔒 Security & Code Standards

  • No Credentials: Never commit credentials, passwords, personal paths, or API keys in your pull requests or examples.
  • Strict Anti-Inline Rule: Ensure any numbered list inside the markdown file includes empty lines (\n\n) between items to prevent rendering issues on markdown platforms.
  • Opt-In Rules: Do not write rules that command the agent to silently modify local file systems or run scheduled loops without user confirmation. All propagation steps must remain transparent and opt-in.

Thank you for your support in making (RTX⚡) the default framework for multilingual developers! 🚀🔥