Skip to content
This repository has been archived by the owner on Nov 5, 2020. It is now read-only.

Latest commit

 

History

History
66 lines (48 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

66 lines (48 loc) · 2.08 KB
Raw

Contributing to ytdl

Thanks for contributing! 😄

The following is a set of guidelines for contributing to ytdl. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Note: Contributions should be made via pull requests to the dev branch of the repository.

Table of Contents

  1. Styleguides
  2. What should I know before I get started?
  3. How Can I contribute?

Guidelines

The following are the guidelines we request you to follow in order to contribute to ytdl.

Styleguides

Commit Messages

The commit messages should follow the following pattern:

feat: Description # if a new feature is added
fix: Description # if a bug is fixed
refactor: Description # if code is refactored
docs: Description # if documentation is added

Issues

update: Description # if an update is required for a feature
bug: Description # if there is a bug in a particular feature
suggestion: Description # if you want to suggest a better way to implement a feature

Code Styleguide

Typescript

The following are the guidelines for Typescript code.

  • There must be no linting errors in the code.
  • No console statements must be present, use the logger defined in src/utils/logger.ts.
  • New objects must have their own defined interfaces as may be required, in src/models/.

Pull Requests

Pull requests should have:

  • A concise commit message.
  • A description of what was changed/added.

What should I know before I get started

You can contribute to any of the features you want by knowing some of the following:

  • Typescript
  • Basic knowledge about requests
  • Basic knowledge about how YouTube works

How Can I Contribute

You can contribute by:

  • Reporting Bugs
  • Suggesting Enhancements
  • Code contribution
  • Pull Requests

Make sure to document the contributions well in the pull request.

It is not compulsory to follow the guidelines mentioned above, but it is strongly recommended.