Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

73 lines (46 loc) · 2.77 KB

Contributing to YouTubeBot

Thank you for your interest in contributing to YouTubeBot! We welcome contributions from the community to help improve and enhance the bot's functionality. This document outlines the guidelines and best practices for contributing to the project.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please read it to understand the expectations we have for everyone who contributes to this project.

How to Contribute

Reporting Issues

If you encounter any bugs, have feature requests, or want to discuss improvements, please open an issue on the GitHub repository. When reporting issues, please provide as much detail as possible, including:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots or error messages, if applicable

Submitting Pull Requests

We welcome pull requests for bug fixes, new features, and improvements. To submit a pull request:

  1. Fork the repository and create a new branch for your changes.
  2. Make your changes, following the code style and conventions used in the project.
  3. Write clear, concise, and informative commit messages.
  4. Test your changes thoroughly to ensure they work as expected and don't introduce new issues.
  5. Submit a pull request to the main branch of the repository.

Please provide a detailed description of your changes in the pull request, explaining the problem you are solving or the feature you are adding.

Development Setup

To set up the development environment for YouTubeBot:

  1. Clone the repository:

    git clone https://github.com/MansionNET/YouTubeBot.git

  2. Install the required dependencies:

    pip install -r requirements.txt

  3. Obtain a YouTube Data API key and create a config.py file with your API key (refer to the README for more details).

  4. Run the bot:

    python youtubebot.py

Code Style

Please follow the existing code style and conventions used in the project. We use PEP 8 as the primary style guide for Python code.

Testing

Ensure that your changes are thoroughly tested and do not introduce new issues. If you are adding new features, please include appropriate test cases to verify their functionality.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Acknowledgments

We appreciate all the contributors who have helped make YouTubeBot better. Thank you for your support and efforts!

If you have any questions or need further assistance, please feel free to reach out to the project maintainers.

Happy contributing!