Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

66 lines (44 loc) · 2.77 KB
Raw

Contributing Guidelines

Introduction

Welcome to PyUtube CLI project! Your contributions are invaluable, and they help make this project better for everyone.

By contributing to this project, you're not only helping improve the tool for yourself but also for other users.

We welcome various types of contributions, including but not limited to:

  • Bug fixes.
  • Feature enhancements.
  • Documentation improvements.
  • Testing and bug triaging.
  • Suggestions and feedback.
  • ...

What We're NOT Looking For

Please refrain from using the issue tracker for support questions. For any inquiries or assistance, feel free to reach out to us through email.

Ground Rules

To ensure a smooth contribution process, here are some ground rules we follow:

  • Cross-platform Compatibility: Ensure compatibility across different platforms such as Windows, and macOS.
  • Transparent Communication: Discuss major changes or enhancements transparently, and seek community feedback.
  • Minimize Code Complexity: Avoid adding unnecessary classes to the codebase; prioritize the use of functions.
  • Incremental Changes: Keep feature versions as small as possible, preferably introducing one new feature per version.
  • Welcoming Environment: Be welcoming to newcomers and encourage contributions from diverse backgrounds.

Your First Contribution

If you're new to open-source contribution, don't worry! Here's how you can get started:

  1. Fork the repository to your GitHub account.
  2. Clone your forked repository to your local machine.
  3. Make Changes: Implement your desired changes or fixes.
  4. Test: Ensure your changes work as expected.
  5. Commit: Follow the commit message guidelines.
  6. Push: Push your changes to your forked repository.
  7. Submit: Create a pull request, detailing the changes you've made and why they're necessary.

Yo Want to Contribute but Don't Know Where to Begin?

  1. See the Pytubefix docs

If you are a bigger contributor, feel free to start with:

  • You can start by looking through issues - issues which should only require a few lines of code, and a test or two.
  • Fix spelling / typo / grammar mistakes in the documentation
  • Comment clean up
  • Adding logging messages or debugging output

Code Review Process

Once you've submitted a pull request, here's what to expect:

  • The core team will review your contribution promptly.
  • Feedback will be provided within a reasonable timeframe.
  • Please respond to feedback and address any requested changes.
  • After approval, your contribution will be merged into the main branch.

We look forward to your contributions and thank you for helping make the YouTube Video Downloader CLI project better for everyone!

Thank You ❤️