Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

53 lines (38 loc) · 2.49 KB
Raw

Contributing to PyTube Downloader

First off, thank you for considering contributing to PyTube Downloader! Your involvement helps us create a better tool for everyone.

How Can You Contribute?

Reporting Bugs

If you encounter any bugs or issues while using PyTube Downloader, please let us know! You can report bugs by opening an issue in our GitHub Issues section. When reporting a bug, please include:

  • A clear and descriptive title
  • A detailed description of the problem
  • Steps to reproduce the issue
  • Any error messages or screenshots
  • Information about your environment (e.g., operating system, Python version)

Suggesting Enhancements

We welcome suggestions for new features and enhancements. If you have an idea that could improve PyTube Downloader, feel free to start a discussion or open an issue. When suggesting an enhancement, please include:

  • A clear and descriptive title
  • A detailed description of the suggested enhancement
  • Any benefits or use cases for the enhancement
  • Any potential drawbacks or considerations

Contributing Code

We also welcome code contributions. If you would like to contribute code, please follow these steps:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/YourFeatureName)
  3. Make your changes
  4. Commit your changes (git commit -m 'Add some feature')
  5. Push to the branch (git push origin feature/YourFeatureName)
  6. Open a pull request

Coding Guidelines

To ensure consistency and quality, please adhere to the following guidelines:

  • Follow the PEP 8 style guide for Python code.
  • Write clear, concise, and well-documented code.
  • Include tests for any new features or bug fixes.
  • Ensure that your changes do not break existing functionality.

Discussing Ideas

We encourage open discussions about new ideas and features. If you have an idea but are not sure about the implementation, feel free to start a discussion in the GitHub Discussions section. This is a great place to brainstorm and collaborate with other contributors.

Code of Conduct

Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

Thank You!

Thank you for taking the time to contribute to PyTube Downloader. Your help is invaluable, and we appreciate your effort to make this project better.

Happy coding!

Thisal D.