Deno 貢獻(xiàn)

貢獻(xiàn)

閱讀 風(fēng)格指南. 請(qǐng)不要讓 性能測(cè)試 變?cè)恪?在 社區(qū)聊天室 獲取幫助。 如果您將要在某個(gè) issue 下做些工作，在那之前請(qǐng)先在 issue 中提示一下。 請(qǐng)?jiān)谡搲媳３謱I(yè)。我們遵循 Rust 的行為準(zhǔn)則 (Code of conduct)。有問題請(qǐng)向 ry 發(fā)郵件(ry@tinyclouds.org)。

開發(fā)

從源碼構(gòu)建的步驟在 這里 發(fā)起一個(gè) Pull Request 在提交之前，請(qǐng)確認(rèn)以下步驟： 存在一個(gè)相關(guān) issue，并且 PR 文本中引用了它。 有覆蓋這些變化的測(cè)試。 確保 cargo test 通過。 使用 tools/format.py 格式化代碼。 確保 ./tools/lint.py 通過。 third_party 的改動(dòng) deno_third_party 包含了大部分 Deno 依賴的外部代碼，所以我們?cè)谌魏螘r(shí)候都知道我們?cè)谶\(yùn)行什么。我們用一些手動(dòng)操作和私有腳本來維護(hù)它，要做出改動(dòng)，您可能需要聯(lián)系 @ry 或 @piscisaureus。

增加 Ops

Ops 又稱“綁定” (bindings)。 我們非常擔(dān)心在添加新 API 時(shí)會(huì)出錯(cuò)。在向 Deno 添加 Op 時(shí)，應(yīng)該研究其他平臺(tái)上的對(duì)應(yīng)接口。請(qǐng)列出如何在 Go、Node、Rust 和 Python 中完成此功能。 例如，參考 deno.rename() 是如何在 PR #671 中提出并添加的。 發(fā)布 以往發(fā)布的所做更改的總結(jié)在 這里。

API 文檔

公開 API 的文檔很重要，我們希望它與代碼內(nèi)聯(lián)。這有助于確保代碼和文檔緊密結(jié)合在一起。

利用 JSDoc

所有通過 deno 模塊以及 global/window 命名空間公開的 API 和類型都應(yīng)該有 JSDoc 文檔。該文檔經(jīng)過解析并可供 TypeScript 編譯器使用，因此易于在下游提供。JSDoc 塊就在它們應(yīng)用的語(yǔ)句之前，并以 /* doc / 表示。例如： /* A simple JSDoc comment / export const FOO = "foo"; 更多信息位于 https://jsdoc.app/