Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 97 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
name: Bug report
description: Something is not working as documented
labels: ['bug']
body:
- type: markdown
attributes:
value: |
Thanks for filing a bug. This library uses YouTube's unofficial Innertube
API, so behavior often varies by video, language, and region — the more
specific you can be, the faster this gets fixed.

If this is a security vulnerability, please **do not** file it here. See
[SECURITY.md](https://github.com/ericmmartin/youtube-transcript-plus/blob/main/SECURITY.md).

- type: textarea
id: what-happened
attributes:
label: What happened?
description: What did you expect to happen, and what happened instead?
validations:
required: true

- type: input
id: video-id
attributes:
label: Video ID or URL
description: >-
If the video is public, this is the single most useful thing you can
provide. Leave blank if the video is private or unlisted.
placeholder: dQw4w9WgXcQ
validations:
required: false

- type: textarea
id: repro
attributes:
label: Reproduction
description: A minimal code sample, including the config you passed.
render: javascript
placeholder: |
import { fetchTranscript } from 'youtube-transcript-plus';

await fetchTranscript('dQw4w9WgXcQ', { lang: 'en' });
validations:
required: true

- type: textarea
id: error
attributes:
label: Error output
description: The full error, including the error class name and stack trace.
render: shell
validations:
required: false

- type: input
id: package-version
attributes:
label: youtube-transcript-plus version
placeholder: 2.0.1
validations:
required: true

- type: input
id: node-version
attributes:
label: Node.js version
placeholder: v22.11.0
validations:
required: true

- type: dropdown
id: environment
attributes:
label: Environment
options:
- Local development
- Server / container
- Serverless (Lambda, Vercel, Cloudflare, etc.)
- CI
- Other
validations:
required: false

- type: checkboxes
id: checks
attributes:
label: Checks
options:
- label: I am using a supported Node.js version (>= 20)
required: true
- label: I searched existing issues for a duplicate
required: true
- label: >-
I confirmed the transcript is actually available for this video on
youtube.com (transcripts can be disabled by the uploader)
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Report a security vulnerability
url: https://github.com/ericmmartin/youtube-transcript-plus/security/advisories/new
about: Please report vulnerabilities privately, not as a public issue.
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Feature request
description: Suggest a new capability or improvement
labels: ['enhancement']
body:
- type: textarea
id: problem
attributes:
label: What problem are you trying to solve?
description: >-
Describe the use case rather than the implementation. What are you
building, and where does the library get in your way today?
validations:
required: true

- type: textarea
id: proposal
attributes:
label: Proposed solution
description: >-
If you have an API in mind, sketch it here — a config option, a new
exported function, a new formatter, etc.
render: typescript
validations:
required: false

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: >-
Have you worked around this already, for example with a custom
`transcriptFetch` or a custom `CacheStrategy`?
validations:
required: false

- type: checkboxes
id: checks
attributes:
label: Checks
options:
- label: I searched existing issues for a duplicate
required: true
- label: I would be willing to open a pull request for this
required: false
36 changes: 36 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!--
Thanks for contributing! Please read CONTRIBUTING.md if you haven't already.
Keep the change focused — one logical change per pull request.
-->

## What does this change?

<!-- A short description of the change and why it's needed. -->

Closes #

## Type of change

- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that changes existing public API)
- [ ] Documentation only
- [ ] Chore / dependencies / tooling

## How was this tested?

<!--
Describe the tests you added or the manual verification you did. If this fixes
a bug, ideally there is a test that fails before the change and passes after.
Remember: tests must mock HTTP with nock, not call YouTube for real.
-->

## Checklist

- [ ] `npm run lint` passes
- [ ] `npm run typecheck` passes
- [ ] `npm run build` passes
- [ ] `npm test` passes
- [ ] Tests added or updated for this change
- [ ] README updated if public API or config options changed
- [ ] Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/)
129 changes: 129 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[eric@ericmmartin.com](mailto:eric@ericmmartin.com).

All complaints will be reviewed and investigated promptly and fairly. All
community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][mozilla].

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

[homepage]: https://www.contributor-covenant.org
[mozilla]: https://github.com/mozilla/diversity
Loading
Loading