Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (28 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.02 KB
Raw

Contributing

Contributions are welcome. If you'd like to improve ZenXYT Bot, please follow these guidelines.

Getting Started

  1. Fork the repository.
  2. Create a feature branch: git checkout -b feature/your-feature-name
  3. Make your changes and commit with clear messages.
  4. Push to your fork and open a Pull Request.

Development Setup

git clone https://github.com/YourUsername/ZenXYT-Bot.git
cd ZenXYT-Bot
pip install -r requirements.txt
cp .env.example .env
# Fill in your API keys in .env

Code Style

  • Follow PEP 8 conventions.
  • Use type hints where practical.
  • Keep functions focused and under 50 lines when possible.
  • Add docstrings to public functions and classes.

Reporting Issues

When opening an issue, please include:

  • Python version (python --version)
  • Operating system
  • Steps to reproduce the problem
  • Relevant log output from bot.log

Security

If you discover a security vulnerability (e.g., credential exposure), please report it privately rather than opening a public issue.