🤝 Contributing to 24xRaven Bot | المساهمة في بوت 24xRaven

Thank you for considering contributing to 24xRaven Bot! | شكراً لاهتمامك بالمساهمة في بوت 24xRaven!

📋 Table of Contents | المحتويات

Code of Conduct
How Can I Contribute?
Development Setup
Coding Standards
Commit Guidelines
Pull Request Process

📜 Code of Conduct | قواعد السلوك

This project adheres to a code of conduct. By participating, you are expected to uphold this code.

Our Standards | معاييرنا

Be respectful and inclusive
Accept constructive criticism
Focus on what is best for the community
Show empathy towards other community members

🎯 How Can I Contribute? | كيف يمكنك المساهمة؟

Reporting Bugs | الإبلاغ عن الأخطاء

Before creating bug reports, please check existing issues. When creating a bug report, include:

Clear and descriptive title
Steps to reproduce the issue
Expected behavior
Actual behavior
Screenshots (if applicable)
Environment details (OS, Python version, etc.)

Suggesting Features | اقتراح ميزات جديدة

Feature suggestions are welcome! Please provide:

Clear description of the feature
Why this feature would be useful
Possible implementation approach
Examples or mockups (if applicable)

Code Contributions | المساهمات البرمجية

Fork the repository
Create a feature branch (git checkout -b feature/AmazingFeature)
Make your changes
Test thoroughly
Commit your changes
Push to your fork
Open a Pull Request

🛠️ Development Setup | إعداد بيئة التطوير

Prerequisites | المتطلبات

Python 3.8+
pip
git

Setup Steps | خطوات الإعداد

Clone your fork

git clone https://github.com/YOUR_USERNAME/24xRaven-Bot.git
cd 24xRaven-Bot

Create virtual environment

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

Install dependencies

pip install -r requirements.txt

Configure the bot

Copy bot.py and add your tokens
Test locally before submitting

📝 Coding Standards | معايير البرمجة

Python Style Guide

Follow PEP 8 guidelines
Use meaningful variable names
Add docstrings to functions
Keep functions small and focused
Comment complex logic

Example | مثال

def calculate_user_stats(user_id):
    """
    Calculate statistics for a specific user.
    
    Args:
        user_id (int): The Telegram user ID
        
    Returns:
        dict: User statistics including message count and join date
    """
    # Implementation here
    pass

Documentation | التوثيق

Update README.md if adding features
Add comments in Arabic and English where helpful
Update CHANGELOG.md

💬 Commit Guidelines | إرشادات الـ Commit

Commit Message Format

<type>: <subject>

<body>

<footer>

Types | الأنواع

feat: New feature
fix: Bug fix
docs: Documentation changes
style: Code style changes (formatting, etc.)
refactor: Code refactoring
test: Adding tests
chore: Maintenance tasks

Examples | أمثلة

feat: Add voice message support

Added functionality to process and respond to voice messages
using speech-to-text API.

Closes #123

fix: Resolve image generation timeout issue

Increased timeout duration and added retry logic for
image generation requests.

🔄 Pull Request Process | عملية الـ Pull Request

Before Submitting | قبل الإرسال

PR Description Template | قالب وصف الـ PR

## Description | الوصف
Brief description of changes

## Type of Change | نوع التغيير
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Code refactoring

## Testing | الاختبار
Describe testing performed

## Screenshots | لقطات الشاشة
If applicable

## Checklist | قائمة التحقق
- [ ] Code follows style guidelines
- [ ] Documentation updated
- [ ] Tests added/updated
- [ ] No breaking changes

Review Process | عملية المراجعة

Maintainer will review your PR
Address any requested changes
Once approved, PR will be merged
Your contribution will be credited

🏆 Recognition | التقدير

Contributors will be:

Listed in CONTRIBUTORS.md
Mentioned in release notes
Credited in project documentation

📞 Questions? | أسئلة؟

Feel free to reach out:

Telegram: @P_X_24
Channel: Raven_xx24
Email: hsh34811@gmail.com

Thank you for contributing! | شكراً لمساهمتك!

Made with ❤️ by ✘ 𝙍𝘼𝙑𝙀𝙉

FilesExpand file tree

CONTRIBUTING.md

Latest commit

History