mirror of
https://github.com/Evil0ctal/Douyin_TikTok_Download_API.git
synced 2026-10-29 12:59:49 +08:00
GitHub scored this repository's community profile at 42%: a licence and a README
and nothing else. The gap is not cosmetic - CONTRIBUTING and SECURITY are what
GitHub links to from the issue and pull-request pages, so their absence means a
first-time contributor is shown nothing.
Pull request template, bilingual. GitHub has no chooser for pull requests the way
it has for issues, so the default is both languages in one file and single
-language variants sit in .github/PULL_REQUEST_TEMPLATE/ behind ?template=.
Its checklist is the one already in the contributing guide - make fmt, lint,
type, test, npm run verify, both documentation languages, the six hygiene rules -
plus one the guide did not have: no credentials in the diff or the description.
The guide's line saying there is no template is now false, and is updated.
CONTRIBUTING.md is short on purpose. The real guide is 500 lines in
documents/{en,zh}/16-contributing.md and duplicating it here would produce two
that disagree within a month. What it does carry is the three things people
actually trip on: source is English, documentation moves in both languages, and
never a credential - the last one because v4 shipped a live session in a tracked
config file.
SECURITY.md says what is in scope and, more usefully, what is not. Platform rate
limiting and risk control are not vulnerabilities, and neither is binding to
0.0.0.0 on a public host after the documentation told you what that costs.
Code of conduct is Contributor Covenant 2.1, verbatim in both languages from the
upstream texts rather than paraphrased - the point of a standard one is that a
contributor already knows what it says.
Dependabot is monthly and grouped, not weekly and per-package. One maintainer
drowns in the defaults, and a stack of ignored bot pull requests teaches you to
skim past the security ones too.
.gitattributes normalises line endings. Nothing tracked has CRLF today; this
keeps it that way, because a \r on the end of an entrypoint shebang fails as
"not found" and names the file rather than the character.
52 lines
2.8 KiB
Markdown
52 lines
2.8 KiB
Markdown
<!--
|
|
GitHub has no template chooser for pull requests the way it has for issues, so
|
|
this one is bilingual and it is what everybody gets. If you would rather have a
|
|
single language, append one of these to the compare URL before you open the PR:
|
|
|
|
?template=en.md English only
|
|
?template=zh.md 只有中文
|
|
|
|
Delete whichever half you did not fill in. Delete these comments too.
|
|
删掉你没填的那一半,也删掉这些注释。
|
|
-->
|
|
|
|
## What changed / 改了什么
|
|
|
|
<!-- Behaviour, not files. "A post that does not exist is an answer, not risk
|
|
control" beats "edited fetch.py". -->
|
|
<!-- 写行为,不要写动了哪些文件。 -->
|
|
|
|
## Why / 为什么
|
|
|
|
<!-- The problem this solves. Link the issue if there is one: Fixes #123 -->
|
|
<!-- 它解决了什么问题。有 issue 就关联:Fixes #123 -->
|
|
|
|
## How you verified it / 你怎么验证的
|
|
|
|
<!-- Commands you ran, what you saw. If something could not be verified - a code
|
|
path needing the live platform, a browser backend you do not have - say so.
|
|
An honest "not verified against a real browser" is worth more than a
|
|
confident claim a reviewer has to disprove. -->
|
|
<!-- 跑了什么命令、看到了什么。有验证不了的地方就直说:比如需要真实平台才能走到的分支、
|
|
你本地没装的浏览器后端。老实说"没在真浏览器上验证过",比一个需要 reviewer 去推翻的
|
|
肯定说法有价值得多。 -->
|
|
|
|
## Checklist / 自查
|
|
|
|
- [ ] `make fmt` — 格式化先跑,免得 CI 挂在空白字符上 / run first, so the gate does not fail on whitespace
|
|
- [ ] `make lint && make type` — ruff and mypy
|
|
- [ ] `make test` — unit, replay and integration
|
|
- [ ] `(cd web && npm run verify)` — 动过 `web/` 才需要 / only if you touched `web/`
|
|
- [ ] 文档 `documents/en/` **和** `documents/zh/` 一起更新了 / user documentation updated in **both**, if a reader would act on the change (a setting, a CLI command, an endpoint, a console page, a default)
|
|
- [ ] 没有:源码里的中日韩字符、tokens 之外的十六进制颜色、JSX 里的字面文案、`TODO`、`.env`、带真实 Cookie 的 fixture / none of: CJK in source, a hex colour outside the tokens file, literal prose in JSX, a `TODO`, a `.env`, a fixture with a real cookie
|
|
- [ ] 没有在 diff 或描述里贴出密钥、口令、Cookie 或 API Key / no key, password, cookie or API key in the diff or in this description
|
|
|
|
<!--
|
|
PR 目标分支是 main。v4 分支已冻结,只接受安全修复。
|
|
Pull requests target main. The v4 branch is frozen and takes security fixes only.
|
|
|
|
新增平台接口 / 控制台页面 / 翻译字符串,各有一节现成的步骤:
|
|
Adding a platform endpoint, a console page or a translated string each has its own
|
|
section in: documents/en/16-contributing.md
|
|
-->
|