Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #27

Merged
merged 12 commits into from
Oct 1, 2024
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### Coding conventions
Since the provider comes in two parts(the **Provider**(coded in typescript) and the **Provider plugin**(coded in python)), we have different code formatting standards for them.
Please format your code by running this script below before you push a commit to your pull request:
```shell
# Make sure you have ruff, autopep8 and prettier installed already
ruff check --fix plugin/
autopep8 --in-place plugin/

cd server
npx prettier --check --write 'src/**/*.{js,ts}'
cd ..
```

#### **Provider**(typescript):
<!--Please complete this, @Brainicism-->
grqz marked this conversation as resolved.
Show resolved Hide resolved

#### **Provider plugin**(python):
We follow the [yt-dlp coding conventions](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#yt-dlp-coding-conventions).
Loading