我提出了这10条简单的规则,希望通过将软件工程最佳实践应用于研究工具文档,您可以创建最具可用性和影响力的软件。 规则1:在编码时编写注释 注释是软件文档中最重要的一个方面。...例如,让我们看一下TPOT机器学习工具的快速入门指南:它有一个显示软件功能的动画图形图像文件(GIF),解释它如何工作的图表,以及一个最小的代码存根,非常适合复制粘贴到你自己的项目。...此外,您应该在自述文件中包含快速入门指南(如规则3中所述)。 通常,自述文件顶部会包含徽章,这些徽章在呈现时会显示软件的状态。徽章的一个常见来源是shields.io,它可以为您的项目动态生成徽章。...常见徽章包括显示自动化测试是否正在传递的徽章(例如来自travis-ci.org的徽章),测试覆盖的代码百分比,文档是否是最新的等等。...在Python中,click(click.pocoo.org)等软件不仅可以提供帮助命令,还可以帮助您创建界面,从而节省您的时间和精力。 良好的CLI的一个例子是Magic-BLAST中包含的CLI。
它应该显示“创建”、“完成”或“发送”。确保可点击区域具有足够的对比度,以便用户轻松发现它。操作区域可以显示在通知容器的右侧或底部。 图标(可选)。有意义的图像可以强化通知的内容。...用户检查更新后,徽章会从应用程序图标中消失,并在新通知到达时再次出现。 右上角带有圆点的铃铛是此类通知的常规设计。 优点: 徽章不需要用户过多关注。徽章不会阻止用户与产品交互。...何时使用: 徽章可以是具有中等重要性的通知的完美解决方案。 小技巧: 考虑提供声音来补充您的通知。声音可能是在不看屏幕的情况下吸引某人注意力的好方法。独特的声音还可以帮助您区分应用的通知。...其次,您可以使用电子邮件通知不需要用户操作的系统更新(即,通知用户订单更新)。 4.Toast Toast 是一个矩形块,显示在用户屏幕的顶部或底部,用于通知用户更新。...何时使用: Toast 是一种很好的操作状态。例如,消息发送应用程序可以在消息发送成功时显示吐司“消息发送”。 提示: 不要使用 toast 来显示与当前用户任务无关的信息。
应用 当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。...`html` `css` `javascript` html css javascript 分隔线 你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。...kbd> 重启电脑 使用 Ctrl+Alt+Del 重启电脑 我是使用b标签的加粗字体 转义 Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用反斜杠转义字符: **...未转义星号显示加粗** \*\* 转义显示星号 \*\* 未转义星号显示加粗 ** 转义显示星号 ** Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号: \ 反斜线 `...感叹号 以下部分在Github或其他在线预览中暂未支持 数学公式 当你需要在编辑器中插入数学公式时,可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。
如何更容易地构建高质量的安全软件?组织内需要建立一个由团队成员一起讨论出来的最佳实践来帮助团队建立明确的努力方向。...如果你的项目在 GitHub 上或是你可以按照上述的徽章计划进行评估,就可以使用它来评估你项目的最佳实践,并可以在项目主页的 README 上显示徽章结果。...定制最佳实践标准 如果上述项目不能满足你的评估要求,结合我的实践,制定了如下“最佳实践标准”并分配了相应的成熟度徽章,供参考。...Email或Slack通知 GOLD Q&A Q: 为什么使用徽章而不是分数?...A: 使用徽章能更好的帮助团队朝着目标而不是分数努力。 Q: 建立最佳实践标准还有哪些帮助? A: 团队之间容易进行技术共享,更容易地构建高质量的安全软件,保持团队之间在统一的高水准。
你还可以将其用于repo的社交预览。 我个人使用Canva网站创建横幅图像。所有基本内容都是免费的(在大多数情况下,你不需要专业版)。 标题下那些华丽的东西是什么? 看起来不错吧?...这些被称为徽章,它们通过提供一些快速见解提高了可读性,对吗? 你可以在你的项目中使用无数徽章,而且它们确实取决于项目。下面是我在每个项目中常用的一些。 我使用Shields IO网站制作徽章。...这也显示了如何在节中添加子节。 赞助 你的项目备受青睐,并且已经被成千上万的人使用(有了这个README文件,将会有更高使用量)。现在,是时候寻找人员或组织来赞助你的项目了。...这可能是因为你没有从项目中获得任何收入,你需要钱来维持项目生存。 你可以在此部分中添加人们如何赞助你的项目。在此处添加你的patreon或GitHub赞助商链接,以方便访问。...一个好主意是还要向赞助商展示他们的组织徽标或徽章,向他们表达你的爱!(总有一天我会找到赞助商,并向他们表达我的爱) 添加新功能或修复错误 这是为了让人们了解如何在你的项目中提出问题或提出功能要求。
✨ GitHub README 统计 GitHub 个人资料奖杯 添加标题或封面图片 添加浮动图像或 GIF 社交图标部分 语言和工具部分 GitHub streak Spotify 播放 徽章 -...按照下面这个简单演练中的步骤,在您的 GitHub 个人资料上自定义您的 Readme.md,使其看起来更有吸引力。我还提供了一些很酷的元素来增加趣味!...https://github.com/wanghao221(可以的话给个星星吧) 来跟我一起操作 1.创建一个新的存储库 去 https://github.com/new 近入存储库名称,该名称应与您的用户名相同...您可以通过单击 右侧的“编辑自述文件”按钮来编辑文件。 如您所见,该文件提供了一个使用 Markdown 制作的模板。 您可以根据自己的喜好对其进行编辑。 单击Commit changes。...[MasterHead](your image link)](your GitHub link) 自定义 HEADER 生成器 自定义横幅生成器 ---- 添加浮动图像或 GIF <img align=
而神奇动物中的徽章使用 tiny3d(蚂蚁开源的一个 3D 渲染库 tiny + tiny-plugin-three) 在 canvas 上渲染的 3D 模型。...方案 1: 模拟物理重力,使用加速度来计算速度 方案 2: 模拟摩擦力,采用摩擦系数一样的衰减系数 我决定采用 方案 2,其更简便、更符合逻辑。...譬如 CSS 编写而成的立体徽章,CSS 原教旨主义 示例:https://explosions.yunyoujun.cn/badge-rotation/ 使用 TypeScript + VueUse...+ CSS + createInertiaAnimation 搭建,顺便给 Vususe 中 swipe 缺失的 touchcancel 事件提了个 PR。...我在 npm 上建立了一个 explosions 的 org,打算在这个 scope 下发些有趣的动效。 如果你也有些想法和兴趣,可以到这里来点 PR 或 Issue。
背景音乐还可以帮助将人们包裹在虚拟世界中。 使环境中的文本最小化。仅显示人们对应用程序体验所需的最基本的信息。 如果需要其他信息或控件,请考虑在屏幕空间中固定显示。...一次限制使用中的参考图像数量。当ARKit在实际环境中查找100张或更少的不同图像时,图像检测性能最佳。如果需要超过100张参考图像,则可以根据上下文更改活动参考图像的集合。...例如,博物馆指南应用程序可以请求允许使用定位服务来确定某人所在的博物馆部分,然后仅查找显示在该区域中的图像。 限制需要精确位置的参考图像的数量。更新参考图像的位置需要更多资源。...按预期使用AR徽章,请勿更改。您可以在参考资料中以折叠和展开形式下载AR徽章。专门使用这些图像来标识可以使用ARKit在AR中查看的产品或其他对象。...切勿更改徽章,更改其颜色,将其用于其他目的,或将其与未使用ARKit创建的AR体验结合使用。 ? 将AR徽章优先于仅字形的徽章。通常,将仅字形徽章用于无法容纳AR徽章的受限空间。
我们来解释一下。当使用place-items时,它将应用于网格中的每个单元格,也就是说单元格的内容都会居中。...使用text-align:center 也可以快速解决问题,考虑以下示例。 ? 如果仅内容需要居中,不一定非要使用flexbox或grid,使用text-align反而会更简单。...当我们需要以为内联的方式显示徽章列表,并且每个徽章都应该是一个flexbox元素,这时就需要 inline-flex 出场了。...通过使用object-fit:contain,我可以控制徽标的width和height,并强制将图像包含在定义的宽度和高度中。??...更好的是,我们可以将以上内容包装在@supports中,以避免在不支持对象适配的浏览器中拉伸徽标图像。
01 背景介绍 在今年的敏捷团队建设中,我通过Suite执行器实现了一键自动化单元测试。Juint除了Suite执行器还有哪些执行器呢?由此我的Runner探索之旅开始了!...页面上方为徽章列表及权益聚合展示,下方为积分气泡聚合领取楼层,包含:白条返积分、徽章升保级积分和财富积分等。...图6 徽章整体架构设计 3.2 业务线的动态接入&等级规则配置 徽章的等级评定,来源于业务线的数据,因此需要将业务线的数据配置到徽章系统中,同时量化平台需要同步加入业务线的字段计算逻辑。...,如果是自动发放的权益,则调用中台服务进行权益发放; d、等级变更MQ:判断等级的变化情况,如果是激活、升级或保级,则根据规则,生成对应的升保级积分; 激活流程:支持业务线账户开通的MQ通知,激活为徽章...针对个性化的需求,后续可以支持插件的形式集成到开发模式中; ▪标准规范-组件化:徽章体系中各业务线徽章详情页具有部分同质化内容,针对这些内容,抽象出标准组件化沉淀至魔笛平台,供后续详情页使用。
今天我要跟你分享的是这其中的一个小徽章 - GitHub 访问徽章。 中呈现的图像都将使用 camo 呈现。
它最适合用来实现诸如评论部分、显示微博、展示包含图像的产品详情等功能。 为你的网站设计一个评论区是一个棘手的任务。你需要小心的设计一些可重用的HTML标签来支持嵌套评论。...如果你愿意,你可以使用很多层的嵌套。 缩略图 使用Bootstrap的缩略图组件,可以快速的完成显示图片或视频缩略图的功能。它用一个有边框环绕的可点击组件来显示图像和视频的缩略图。...你也可以使用”active”类来高亮显示列表中的任何元素。 导航组件 导航栏和面包屑组件是许多网站的重要部分。Bootstrap附带了许多用于帮助构建这些特性的组件。...您还可以尝试调整浏览器的大小,并使用隐藏的按钮来显示屏幕较小的菜单。您应该有类似图的内容。 ? 惊讶吗?您不需要编写一行CSS或JavaScript代码,已经创建了一个可响应的导航栏。...使用符号代替小图像有很多优点,包括: 为小图像或精灵保存多个请求; 由于它们是字体图标,它们的颜色和大小可以在使用CSS属性的过程中变化; 在所有的展示中,他们看起来都很干脆利落。
在这篇文章中,我们将详细介绍 OpenSSF 及其最佳实践徽章计划,探讨如何通过该计划帮助开源项目提高安全性。我们还将讨论如何为项目申请徽章,并了解徽章计划的不同级别和要求。...Criteria Statistics 注册并关联项目 访问 OpenSSF 最佳实践徽章项目网站,使用 GitHub 账户或注册一个新帐户。...表单会根据你 GitHub 项目的配置自动填写一部分内容,但不是 100% 准确,需要你根据项目的实际情况来填写内容,并将证明 URL 或说明补充在表单内,全部填写完成后点击 Submit(and exit...展示徽章 OpenSSF 最佳实践徽章计划会提供徽章的图像和嵌入代码,以方便您在各种平台上展示徽章。...此外,您还可以将徽章作为激励,进一步提高项目的安全性性,以获得 SILVER(银牌)或 GOLD(金牌)的徽章。
有很多CSS属性,有些人不了解,或者他们了解它们,但是忘记在需要时使用它们。其实,有时候我们用 JavaScript 来实某些交互,CSS 一个属性就能搞定了,这可以大大节约我们编码的时间。...我们来解释一下。当使用place-items时,它将应用于网格中的每个单元格,也就是说单元格的内容都会居中。...display: inline-Flex 属性 当我们需要以为内联的方式显示徽章列表,并且每个徽章都应该是一个flexbox元素,这时就需要 inline-flex 出场了。...通过使用object-fit:contain,我可以控制徽标的width和height,并强制将图像包含在定义的宽度和高度中。??...更好的是,我们可以将以上内容包装在@supports中,以避免在不支持对象适配的浏览器中拉伸徽标图像。
要阅读发送给你的消息,页面顶部的导航栏将会有一个新的“消息”链接,它会将你带到与主页或发现页面相似的页面,但不会显示用户动态,它会显示其他用户发送给你的消息。...new_messages()辅助方法实际上使用这个字段来返回用户有多少条未读消息。在本章的最后,我将把这个数字作为页面顶部导航栏中的一个漂亮的徽章。...我注意到除了Message具有额外的recipient关系(我不需要在消息页面中显示,因为它总是当前用户),Post和Message实例具有几乎相同的结构。...06 动态消息通知薇章 上一节介绍的解决方案是一种简单的常规方式来显示通知,但它有一个缺点,即徽章仅在加载新页面时刷新。...我还为表示徽章的元素添加了一个id属性,以便使用$('#message_count') jQuery选择器来简化这个元素的选取。
在这篇文章中,我分享使用 Jetpack Compose 和 Material 3 实现一个高级的 NimNavBottomApp 的开发过程,为大家提供开发灵感和实践经验。...这个Demo,我实现了一个常见的底部导航栏App,包括多个页面切换、选中状态的高亮显示、徽章通知的显示等功能。...二、项目开发 2.1 介绍Badges UI组件 底部导航栏的每个菜单项展示图标和标签,还可以显示通知徽章。徽章可以提醒用户有未读的消息or待处理的任务。...3.2 徽章的动态更新 需要根据用户的操作或者后端的反馈,动态更新每个导航项的通知徽章。为此,通过一个Map存储每个页面的通知数量,根据页面的变化动态显示或隐藏徽章。...四、学习笔记 在这个Demo开发过程中,我掌握了如何在 Jetpack Compose 中处理复杂的状态管理,虽然学习成本较高,但掌握了 Compose 的核心思想,很方便开发。
xl-2019-waiting-webpage-1.jpg 谷歌计划在周一宣布,它将使用性能徽章来警告用户即将浏览的网站加载缓慢。...谷歌的Chrome团队正在与其他谷歌团队合作,考虑使用徽章来评估预期的用户体验质量。其长期目标是将徽章用于高质量的体验,其中可能包括速度以外的其他性能。...“ [私营公司]中总会有一些人知道这是一个问题,但可能无法获得解决问题所需的支持或资源。拥有Google的耻辱公开徽章应该为他们提供更多的来改变的利器。”...“我可以想象那些负责升级缓慢网站性能的开发人员或运营团队之间的相互指责。” Tirias的McGregor指出,尽管有些人认为徽章是不公平的,但“实际上,它与算法一样公平。”...开发人员可以,比如说,用力打造出一个快速的最初屏幕绘画,但仍然提供较差的用户体验。 开发人员可以通过逐步加载图像,放置又小又差的图像以吸引观看者的注意力来糊弄这个评价系统。
准备 本文列出的创建动画图表的步骤并不是孤立地考虑的,必须考虑整个过程。需要什么原始数据?如何将其聚合以显示想要什么?在绘制图表之前,是否需要对聚合数据进行进一步处理?使用哪种类型的图表?...收集数据 首先要做的是决定需要显示哪些数据,然后将其收集在一起。 这很容易解决,因为知道要显示一支球队在排行榜上的位置,所以需要计算他们在获胜或平局中的得分。...筛选是周数,因此通过更改它,数据透视表将显示季节中该周的数据。 创建要绘制图表的数据 显然,图表需要显示每个队的得分。...但正如已经提到的,它还需要能够根据进球差和得球数来区分哪个球队在积分榜上名列前茅。 还想使用每个球队的俱乐部徽章来显示与该俱乐部相关的数据。 使用簇状条形图,可以完成所有这些。...系列1是俱乐部的实际得分。系列2是调整后的积分,考虑到进球差和进球得分,可以使用俱乐部的徽章作为本系列的标签。 为了创建所需的数据,创建了一个表,该表使用GETPIVOTDATA从数据透视表中获取值。
新出现在Ubuntu15.04中的一个软件包解决了我对Unity欢迎屏的微词:像Cinnamon这样的其它Linux桌面会话没有徽章图标。...我知道这有点吹毛求疵了;这只是对大多数人而言几乎毫无影响的视觉瑕疵罢了。但是这种不一致性时时刻刻缠绕着我,让我不胜其烦,因为Ubuntu的一些会话带有徽章图标,包括Unity、GNOME和KDE。...这些点点们造成的这种不一致性刺激着我的神经,即使它只是稍纵即逝,但这种刺激不仅仅来自设计,也来自可用性方面。标牌式的标志符号对于让我们知道我们即将登陆到哪个会话很有帮助。...也能是Cinnamon……我必须点开它才能知道。 没有必要这样做啊。构建UnityGreeter,就是为了让桌面环境开发者能够部署徽章到欢迎屏幕中(有些确实这样做了)。...与其依赖桌面制造者自己来添加品牌式徽章到他们的包中,与其给Ubuntu增加维护它的责任重担,Torrance还不如自己创建了一个独立的‘unity-greeter-badges’包来收容它们。
新出现在 Ubuntu 15.04中的一个软件包解决了我对Unity 欢迎屏的微词:像Cinnamon这样的其它Linux桌面会话没有徽章图标。...我知道这有点吹毛求疵了;这只是对大多数人而言几乎毫无影响的视觉瑕疵罢了。但是这种不一致性时时刻刻缠绕着我,让我不胜其烦,因为Ubuntu的一些会话带有徽章图标,包括Unity、GNOME和KDE。...这些点点们造成的这种不一致性刺激着我的神经,即使它只是稍纵即逝,但这种刺激不仅仅来自设计,也来自可用性方面。标牌式的标志符号对于让我们知道我们即将登陆到哪个会话很有帮助。...也能是 Cinnamon……我必须点开它才能知道。 没有必要这样做啊。构建Unity Greeter,就是为了让桌面环境开发者能够部署徽章到欢迎屏幕中(有些确实这样做了)。...与其依赖桌面制造者自己来添加品牌式徽章到他们的包中,与其给Ubuntu增加维护它的责任重担,Torrance还不如自己创建了一个独立的‘unity-greeter-badges’包来收容它们。
领取专属 10元无门槛券
手把手带您无忧上云