ARTICLE DETAIL

资讯详情

深耕郑州网站建设与运营推广的一线实战洞察。

awesome-design-patterns 贡献指南:设计模式精选清单的条目规范与 Pull Request 提交流程

awesome-design-patterns 贡献指南:设计模式精选清单的条目规范与 Pull Request 提交流程 文档技术博客【免费下载链接】awesome-design-patternsA curated list of software and architecture related design patterns.项目地址https://gitcode.com/GitHub_Trending/aw/awesome-design-patterns点击查看免费下载导读本文以仓库中的 contributing.md 为纲完整解析向 awesome-design-patterns 这份「软件与架构设计模式精选清单」提交资源的九条准入准则、统一的条目格式name - Description.以及从 Fork 到 Pull Request 的完整提交流程。读完你将能按照仓库规范撰写一条格式合规、可被清单直接收录的设计模式资源条目并独立完成一次规范的 GitHub 贡献。一、文档定位contributing.md 在仓库中的角色该仓库结构极简仅包含三个文件README.md清单本体收录了数百个按主题分类的设计模式资源contributing.md贡献规范规定「什么样的资源可以进清单、以什么格式进、通过什么流程进」_config.yml站点配置指定 jekyll-theme-architect 主题。在 README.md 的 Contributing 小节中明确写道Your contributions are always welcome! Please read the contribution guidelines first.——也就是说contributing.md是任何贡献者的第一道入口。全文分为两部分九条 Pull Request 准则与GitHub 贡献步骤五步命令行流程 一条网页备用路径内容精炼但覆盖了从内容质量、格式规范到协作流程的完整闭环。二、九条贡献准则逐条解析附 README 实例印证contributing.md 的准则部分contributing.md看似是通用模板实则每一条都针对「设计模式精选清单」的特定场景做了约束。逐条拆解如下#准则原文要点解读README 中的印证1好的设计模式资源应讲解并解释多个模式而非只描述单个模式清单定位是「精选」单篇只讲一个模式的文章价值密度低容易被过滤Java 小节的 java-design-patterns、sourcemaking描述即为patterns and anti patterns、General Architecture 小节的 system-design-primerDesign large-scale systems均属多模式资源2提交新条目前先搜索既有建议防止重复精选清单最忌冗余条目即使清单自身也偶有跨小节重复详见下文分析3使用统一格式name - Description.机器可读、风格一致的条目是 awesome 系列清单的基本盘README 绝大多数条目严格遵循该格式4欢迎新分类或对既有分类的改进清单的目录结构本身是可演进的Contents 已有 13 个一级分类且存在 Books、Other Awesome Lists 等特殊章节5描述要简短、简洁但具有描述性一行描述要让人一眼判断该资源是否值得点开如 PyPattyrn 条目A simple library for implementing common design patterns.6所有描述以句号结尾细节即规范统一标点避免风格漂移上述示例描述均以.结尾7检查拼写与语法清单面向全球开发者阅读文案质量即项目质量属于写作规范无源码可印证但可直接对照校验8PR 中应包含资源链接并说明入选理由链接保证可验证性理由帮助维护者快速决策属于 PR 描述要求作用于提交内容而非 README 本身9模式必须与软件相关明确边界排除纯业务/纯视觉等泛化「模式」内容与 README 开头定义一致software and architecture related design patterns其中第 2 条值得展开README 中《Django Design Patterns and Best Practices》同时出现在 Python 小节README.md与 Books 章节README.md《Node.js Design Patterns》《MongoDB Applied Design Patterns》等书目也存在类似情况。这恰好说明「跨小节查重」是真实存在的痛点——即便成熟清单也难以完全避免因此提交前务必在仓库内全文搜索确认你的候选资源未被收录。三、条目格式规范name - Description.解剖contributing.md 第 7 行规定的格式是唯一准入格式共三个组成部分组成片段作用来自 README 的实例链接以…省略[name]资源的可见名称尽量使用社区公认的项目名[design-patterns-for-human]、[PyPattyrn]、[system-design-primer](link)资源的真实地址仓库、文档页或书籍页README 中对应条目的链接部分- Description.破折号后接简短描述必须以句号结尾ultra simplified explanation to design patterns.以下是从 README.md 各小节摘录的真实条目已省略链接可直观对照格式design-patterns-for-human - ultra simplified explanation to design patterns. PyPattyrn - A simple library for implementing common design patterns. Vue Patterns - Useful Vue patterns, techniques, tips and tricks and curated helpful links. sourcemaking - patterns and anti patterns.注意描述语的取舍ultra simplified explanationC#、PHP 小节的for humans系列、useful patterns...and curated helpful linksVue 小节都在 10 个词左右完成「这是什么 为什么值得看」的说明这正是第 5 条「简短、简洁但具有描述性」的量化示范。四、五步完成一次贡献Fork → Branch → Commit → Push → PRcontributing.md 第 20-24 行给出了标准流程原文命令如下# 1. Fork it! —— 在 GitHub 上将本仓库 Fork 到你的账号 # 2. Create your branch git checkout -b my-new-branch # 新建并切换到特性分支 # 3. Commit your changes git commit -am fix stuff # 暂存已跟踪文件的修改并附带提交信息 # 4. Push to the branch git push origin my-new-branch # 将本地分支推送到你的 Fork 远端 # 5. Submit a pull request —— 在 GitHub 上发起 PR 请求合并各步骤的实操要点Fork在 GitHub 仓库页右上角点击 Fork得到一份属于你自己的副本后续所有提交都基于该副本进行避免直接污染主仓库。创建分支git checkout -b my-new-branch一次性完成「新建 切换」分支名建议与改动内容相关如add-python-patterns-resource比示例中的my-new-branch更利于维护者辨识。提交git commit -am fix stuff中的-a表示自动暂存所有已被跟踪且发生修改的文件新增的未跟踪文件仍需先git add-m附带提交信息。对贡献清单类仓库而言一次 PR 通常只涉及对 README.md 的一个条目级修改保持单次提交、信息明确即可。推送git push origin my-new-branch将分支推送到你的 Fork若 Fork 落后于上游可先同步上游再推送这是常规 Git 协作实践。发起 PR在 GitHub 的 Compare Pull Request 页面填写 PR 描述。此处务必落实第 8 条准则——在 PR 描述中附上资源链接并说明入选理由例如该资源覆盖了哪些设计模式、适合哪类读者、与既有条目相比有何增量这能显著加快维护者的审阅决策。五、备用路径在 GitHub 网页直接编辑 README 并提交 PRcontributing.md 第 26 行补充了一条零命令行路径or manually edit the readme file in github and create a pull request。实操方式为打开 README.md 的展示页点击右上角铅笔图标进入编辑模式在对应小节的列表末尾按name - Description.格式插入新条目在页面底部的提交说明中填写修改摘要GitHub 会自动创建 Fork 与分支并引导你进入Create Pull Request页面完成提交流程。该路径适合单条目、小改动省去了本地环境配置多条目的结构调整仍建议走第四节的标准 Git 流程。六、从仓库结构看清单组织为什么格式与分类如此重要对照 README.md 的 ContentsREADME.md可以更深刻理解各条准则背后的设计意图13 个一级分类Programming Language Design Patterns、General Architecture、Cloud Architecture、Serverless Architecture、Micro services Distributed Systems、Internet of things、Big Data、Machine Learning、Databases and storage、DevOps containers、Mobile、Front End Development、Security语言子分类编程语言小节下再按 AngularJS、C#、C、Go、Java、JavaScript、Kotlin、Node、PHP、Python、React、Ruby、Rust、Scala、Swift、TypeScript、Vue.js、Elixir、UML 等细分条目必须落到正确的语言子列表特殊章节Books、Other Awesome Lists 收纳跨语言的书目与衍生清单。这份层级结构就是第 4 条「欢迎新分类」的落点——当一个主题如新的云厂商模式、新的框架范式在现有分类中找不到合适归属时提出新分类本身就是被鼓励的贡献形式。同时仓库以 _config.yml 配置的 jekyll-theme-architect 主题通过 GitHub Pages 渲染README.md 即是站点与清单的单一事实来源其顶部还挂着 PRs Welcome 徽章明确表达对贡献的开放态度。正因如此条目的格式一致性直接决定了整张清单的可检索性与可引用性——这也是第 3、5、6 条格式类准则存在的根本原因。七、提交前自检清单综合 contributing.md 全部准则可形成一份提交前逐项核对的清单资源同时讲解并解释多个设计模式而非只介绍单个模式已在仓库内全文搜索确认与既有条目不重复含跨小节、跨语言子分类条目严格遵循name - Description.格式描述简短、简洁、有描述性参考 10 词左右的优秀范例描述以句号.结尾拼写与语法经复核无误主题确属软件相关的设计模式范畴条目已放入最匹配的现有分类或附上新分类建议PR 描述中包含资源链接与入选理由。小结contributing.md 以极简篇幅定义了 awesome-design-patterns 的「内容准入 格式标准 协作流程」三层规则准入层用「多模式、软件相关、无重复」过滤资源格式层用name - Description.统一可读性流程层用 Fork 工作流或网页编辑保证主仓库整洁。对贡献者而言读懂这 26 行文档并对照 README.md 的既有条目演练一遍即可完成一次高质量、可被直接收录的设计模式资源贡献。赞分享文档技术博客【免费下载链接】awesome-design-patternsA curated list of software and architecture related design patterns.项目地址https://gitcode.com/GitHub_Trending/aw/awesome-design-patterns点击查看免费下载相关推荐BPfold论文精读碱基对基序能量如何推动RNA结构预测进入深度学习时代BPfold论文精读碱基对基序能量如何推动RNA结构预测进入深度学习时代 BPfold作为RNA结构预测领域的创新模型通过碱基对基序能量与深度学习的结合为Boltz贡献者指南代码规范与Pull Request提交流程Boltz贡献者指南代码规范与Pull Request提交流程 引言 你是否在为开源项目贡献代码时遇到过代码风格不统一、PR提交被反复要求修改的问题本文将详人工智能基础模型深度学习生物信息学XHS-Downloader Pull Request模板规范贡献提交的格式XHS Downloader Pull Request模板规范贡献提交的格式 描述 ! 请简要描述此PR的目的和解决的问题 变更类型 新功能 Feature网页爬虫上一篇碧蓝航线Live2D模型提取实战从游戏资源到创意素材的完整转换方案下一篇3分钟搞定Figma中文界面终极免费汉化插件使用指南创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表