jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-02 12:23:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: simplify CONTRIBUTING.md

Browse Source 
Old one was way too verbose, and contained weird, unnecessary wording.
This commit is contained in:
Luan
2026-05-12 22:02:28 -03:00
committed by GitHub
parent 717c67db67
commit f66d782276
1 changed files with 8 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTING.md
View File

@@ -1,24 +1,22 @@
Welcome to YouTube.js! We're thrilled to have you interested in contributing to our project. As a community-driven project, we believe in the power of collaboration and look forward to working with you. To get started, please follow our guidelines:
## Issues
### Creating a new issue
Before creating a new issue, we recommend searching for similar or related issues to avoid duplication efforts. However, if you can't find one, you're more than welcome to create a new issue using a relevant issue form. Please make sure to describe the issue as clearly and concisely as possible.
Before creating a new issue, search for similar or related issues to avoid duplication efforts. If you can't find one, you're more than welcome to create a new issue using a relevant form, and please make sure to describe the issue as clearly as possible.
### Solving an issue
If you want to lend a hand by solving an issue, it's always good to browse existing issues to find one that grabs your attention. You can narrow down the search using tags as filters. If you find an issue you'd like to help with, please feel free to open a Pull Request with a fix. We appreciate documentation updates and grammar fixes too!
If you want to help solve an issue, it's always good to browse existing issues to find one that grabs your attention, you can narrow down the search using tags as filters. Simple documentation updates and grammar fixes are welcome too.
## Making Changes
1. Fork the repository on GitHub.
2. Ensure that you have the latest Node.js v20 version installed.
3. Create a working branch and start making your changes and improvements!
2. Ensure that you have the latest Node.js version installed.
3. Create a working branch and start making your changes!
### Committing updates
When you're done with the changes, make sure to commit them. Don't forget to write a clear, descriptive commit message. We recommend following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
### Committing Your Changes
When you're done with the changes, make sure to commit them. Don't forget to write a clear, descriptive commit message. We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
### Creating a Pull Request
Once you're happy with your updates, create a pull request on GitHub. This is the most efficient way to get your contribution reviewed and eventually merged into our codebase.
Once you're happy with your changes, create a pull request on GitHub.
- Use the pull request template to fill in the necessary details.
- If you're solving an issue, link the pull request to that issue.
@@ -35,7 +33,7 @@ npm run test
Linting:
```sh
npm run lint
npm run lint:fix
```
Building:
@@ -55,12 +53,6 @@ npm run build:deno
# ES Module
npm run build:esm
# Node
npm run bundle:node
# Browser
npm run bundle:browser
npm run bundle:browser:prod
```
We appreciate your efforts and contributions to YouTube.js! Together, we can make this project even better.