Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (51 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

59 lines (51 loc) · 1.94 KB

Contributing to AdvAITelegramBot

Thank you for your interest in contributing! Your help makes this project better for everyone.

🐞 Reporting Bugs & Requesting Features

  • Bugs: Please open an issue with clear steps to reproduce, expected vs. actual behavior, and any relevant logs or screenshots.
  • Feature Requests: Open an issue describing your idea and its use case. The more detail, the better!

🛠️ Development Setup

  1. Fork the repository and clone your fork: 
    git clone https://github.com/TechyCSR/AdvAITelegramBot.git
cd AdvAITelegramBot
  2. Create a virtual environment: 
    python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
  3. Install dependencies: 
    pip install -r requirements.txt
  4. Copy and edit config: 
    cp config.example.py config.py
# Edit config.py with your credentials
  5. Run the bot locally: 
    python run.py

🧑‍💻 Coding Standards

  • Use clear, descriptive variable and function names.
  • Follow PEP8 for Python code style.
  • Write docstrings for new modules, classes, and functions.
  • Keep functions small and focused.
  • Add comments where logic may not be obvious.
  • Test your changes before submitting a PR.

🚀 Submitting Pull Requests

  1. Create a new branch for your feature or fix: 
    git checkout -b feature/your-feature-name
  2. Commit your changes with clear messages.
  3. Push to your fork and open a Pull Request (PR) against the main branch.
  4. Describe your changes in the PR template. Link related issues if applicable.
  5. Be responsive to feedback and make requested changes.

🤝 Code of Conduct

  • Be respectful and welcoming to all contributors.
  • No harassment, discrimination, or inappropriate language.
  • Assume good intent and help others learn.

Thank you for helping make AdvAITelegramBot awesome! 🚀