教程【免费下载链接】jstipsThis is about useful JS tips!项目地址https://gitcode.com/gh_mirrors/js/jstips点击查看免费下载导读本文基于 jstips 仓库的贡献规范文档CONTRIBUTING_es_ES.md另有英文版 CONTRIBUTING.md、简体中文版 CONTRIBUTING_zh_CN.md 与繁体中文版 CONTRIBUTING_zh_TW.md完整讲解向该开源项目提交 JavaScript 技巧tip的操作流程从 fork 仓库、按规范命名文件到套用文章模板、发起 Pull Request再到通过社区多人审查最终合入的完整链路。读完本文你将掌握 jstips 投稿的每一项硬性要求文件命名、Front Matter 字段、内容规范以及仓库内真实示例所展示的实战写法。jstips 是一个两分钟内读完一条有用 JS 技巧的开源合集项目简介见 README.md全部内容以 Markdown 文件形式按语言存放于 _posts 目录。贡献流程的核心是fork 仓库 → 新建符合命名规则的文件 → 套用模板写作 → 发起 PR → 等待 5 人审查并给出→ 合入。一、投稿的整体流程根据贡献文档向 jstips 提交一条 tip 需要走完以下步骤fork 仓库将 jstips 复制到你的账户下新建文件根据 tip 的语言在_posts下对应语言目录中创建一个新 Markdown 文件按模板写作使用 POST_TEMPLATE.md 提供的格式撰写内容发起 Pull Request按照 PULL_REQUEST_TEMPLATE.md 填写 PR 信息等待审查tip 进入under review状态经 5 人审查并给出后变为ready to merge随后合入列表。整个状态流转可以概括为一条流水线Tip proposal提交⇒Tip under review审查中⇒Tip ready to merge可合并二、仓库的语言目录结构与文件命名规范2.1 目录结构投稿的第一步是放到正确的目录目录按语言划分位于 _posts 之下_posts/en/英文 tips其中再按技术领域细分javascript/、angular/、react/、more/等子目录_posts/es_ES/西班牙语 tips_posts/zh_CN/简体中文 tips_posts/zh_TW/繁体中文 tips。从仓库实际内容可以看到例如英文目录下有 _posts/en/javascript/2016-01-03-improve-nested-conditionals.md对应的西班牙语版本位于 _posts/es_ES/javascript/2016-01-03-improve-nested-conditionals.md。如果你的 tip 是关于 React 的就放在对应语言的react/子目录关于 Angular 的放在angular/无法归入以上类的通用主题放在javascript/或more/。2.2 文件命名规则文件名必须遵循以下格式2016-xx-xx-name-of-your-tip例如2016-01-03-improve-nested-conditionals。要点如下前缀是日期格式为年-月-日日期和编号部分在投稿阶段保留为xx占位详见下文注意事项中间是用连字符连接的 tip 主题描述即name-of-your-tip文件扩展名为.md。日期与 tip 编号在投稿时先用xx占位当 PR 被标记为ready to merge时维护者会告知正确的编号届时再补齐。三、文章模板Front Matter 字段详解写作时必须使用 POST_TEMPLATE.md 规定的格式。该模板本质上是一个带 YAML Front Matter 的 Markdown 文件下面结合仓库真实文章逐一说明每个字段。3.1 标准模板结构--- layout: *post title: Demo post tip-number: xx tip-username: tip_js tip-username-profile: https://twitter.com/tips_js tip-tldr: Just a demo !-- tip-writer-support: Paypal, Coinbase, Etc -- !-- tip-translator-support: Paypal, Coinbase, Etc -- categories: - en --- content here ### Subtitles format3.2 字段含义与真实示例对照以仓库中编号为 03 的真实文章 _posts/en/javascript/2016-01-03-improve-nested-conditionals.md 为例字段含义模板示例真实示例layout页面布局类型*postposttitle文章标题不得出现JavaScript字样Demo postImprove Nested Conditionalstip-numbertip 编号投稿阶段写xxxx03tip-username作者用户名tip_jsAlbertoFuentetip-username-profile作者主页链接Twitter 链接GitHub 链接tip-tldr一句话摘要TL;DRJust a demoHow can we improve and make a more efficient nested if statement in javascript?tip-writer-support作者收款支持链接可选默认注释掉Paypal/Coinbase 等可选tip-translator-support译者收款支持链接可选Paypal/Coinbase 等可选categories分类第一项为语言如en/es_ES/zh_CN/zh_TW第二项为技术领域如javascript/react- en- en- javascript模板中tip-writer-support和tip-translator-support默认以 HTML 注释形式存在如果你有 PayPal、Coinbase 或其他收款账户把链接填进去读者就可以为你的知识请喝一杯啤酒不需要则保持注释状态即可。3.3 正文格式模板正文区为content here并提示可用### Subtitles format添加子标题。真实文章的正文通常结构为开头用一句话点明要解决的问题对应tip-tldr用javascript代码块展示技巧必要时用###级子标题分段用文字说明原理与使用场景。例如 03 号文章就是先抛出如何优化嵌套if语句的问题再依次给出switch、switch(true)条件判断、函数重构、对象映射四种演进方案。四、内容硬性要求贡献文档列出了投稿必须满足的五条要求投稿前务必逐条核对两分钟内可读完tip 必须短小精悍符合 jstips快速学习的定位README 中同样强调 In less than 2 minutes, you can read about...允许附带扩展链接欢迎添加其他网站或视频链接帮助读者获得更深入的理解代码用js标记所有 JavaScript 代码必须放在带js语言标识的 fenced code block 中确保语法高亮正确标题中不写JavaScript因为整个项目就是关于 JavaScript 的标题无需重复原文 Dont mention JavaScript in the title反引号规则在title和tip-tldr字段中如需标记行内代码必须使用反引号。警告这两个字段的值本身不能以反引号开头Both values must not start with backticks。五、发起 Pull Request5.1 使用 PR 模板tip 写好后需要以 PULL_REQUEST_TEMPLATE.md 为模板发起 Pull Request。该模板结构如下## [Title here] ## TL;DR; [content here] ## Username [twitter account link or github account link ej: [tips-js](https://twitter.com/tips_js)] ## Extra [content here]Title本次 PR 的标题即你的 tip 标题TL;DR与 Front Matter 中tip-tldr对应的一句话摘要Username你的 Twitter 或 GitHub 主页链接Extra其他补充信息可选。5.2 审查阶段PR 提交后即进入under review状态。仓库的审查机制如下每条 tip 需要经过5 人审查且审查者都给出表情后状态才会变为ready to merge审查通过后维护者会告知正确的日期和 tip 编号由你补全后合入列表。六、注意事项xx占位符投稿期间文件名的日期部分和 Front Matter 中的tip-number一律保留为xx不要自行编号避免与已有 tip 冲突squash 提交请将你的多次提交压缩squash为一次 commit保持提交历史整洁多语言支持jstips 同时维护英文、西班牙语、简体中文、繁体中文四套内容各语言目录见 _posts你的投稿可以先用母语写作也可以参考 CONTRIBUTING_zh_CN.md 等对应语言文档了解本地化要求西班牙语投稿者请直接以 CONTRIBUTING_es_ES.md 为准。七、投稿前自检清单结合全文提交前请对照检查文件位于_posts/语言/领域/下正确的目录文件名符合YYYY-MM-xx-name-of-your-tip格式日期与编号用xx占位已套用 POST_TEMPLATE.md 的 Front Matter字段完整title与tip-tldr中无JavaScript字样标题且不以反引号开头代码块使用js标记全文可在两分钟内读完PR 已按 PULL_REQUEST_TEMPLATE.md 填写提交已 squash。完成以上步骤后你的 tip 就进入了社区审查流水线Tip proposal ⇒ Tip under review ⇒ Tip ready to merge。期待你的贡献赞分享教程【免费下载链接】jstipsThis is about useful JS tips!项目地址https://gitcode.com/gh_mirrors/js/jstips点击查看免费下载相关推荐CodeLlama 开源贡献指南如何向官方仓库提交 PRCodeLlama 开源贡献指南如何向官方仓库提交 PR 你是否在使用 CodeLlama 时遇到过 bug或者有改进代码的想法却不知道如何贡献本文将带你人工智能大模型基础模型代码模型本地部署Git-Tips开发者指南如何贡献你自己的Git技巧想要为Git Tips项目贡献自己的Git使用技巧吗作为最常用的Git技巧和窍门集合Git Tips欢迎所有开发者分享他们的宝贵经验。本文将为你详细介绍完整文档教程版本控制Deep-Live-Cam 实时换脸3 步完整上手指南Deep Live Cam 实时换脸3 步完整上手指南 刚 clone 完仓库的用户最常卡住的点是两个models 文件夹是空的导致 Deep Live C人工智能AI 应用计算机视觉媒体生成创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考