首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

记在github中开发项目的正确姿势

只要将Github账号绑定Travis CI,并且勾选需要持续集成repo,在项目中配置好配置文件,那么只要项目有了新commit,Travis CI就会在他虚拟机里执行测试代码,返回成功或者失败...插入徽章(badge) 所谓badge实际上就是一张与项目实时同步图片,能够简明扼要反映项目的各种参数特征。基本用法就是在README.md里插入类似这样代码[!...coverage 这个徽章可以从coveralls.io这类测试框架里搞到,他会显示最近一次测试中返回代码覆盖率,并以百分比形式显示在徽章上,覆盖率越高,颜色越绿。。。...他评价标准不是代码质量,而是项目的issue处理,版本迭代次数以及下载次数等情况。具体算法也发布在他github主页里,可供参考。...我总觉我写README应该还能说过去把。。 Github设置 一般情况下,我们还是认真写下显示在Github上面的项目简介,以及topic选择,这样有助于别人找到自己项目

36930
您找到你想要的搜索结果了吗?
是的
没有找到

用正确姿势开源Python项目

目录结构(初始化) 一般我们都会选择在项目的顶层包含较基础文件,比如setup.py,requirements,README等文件。...一般情况下,一个预发布Python项目中应该包含以下几类文件: projects (项目的主体文件) setup.py requirements Readme (项目说明) docs (项目文档) test...Read the Docs 持续文档集成 说完写文档就不得不提到Read the Dosc了,这是一个第三方文档托管平台,使用Django开发,它可以很轻松Github项目进行集成,在每次代码提交时候会自动进行文档构建...在使用之前,我们需要先做一些初始化操作: 创建.travis.yml文件 我们需要告诉它一些基本信息: 我们项目使用语言 项目使用语言版本 环境依赖 是否需要sudo权限运行 使用什么命令来安装...测试覆盖率检查 Coveralls可以很友好支持Github和Bitbucket仓库导入,同时也可以很好和Travisci集成,在上面我们.travis.yml文件中,在最后一项after_success

87330

coveralls 不解之缘

阅读大约需要 4.5 分钟 前两天在 GitHub 浏览 Python 三方库时,看到了以下图片 ? 就像 https 那个绿色锁标志一样,看着很可信,让人用着放心,很多开源项目都有这些图标。...探索了一番,发现原来这是叫 coveralls 三方库实现,用于在线实时显示单元测试覆盖率,测试数据是通过 coverage 来跑出来。 ?...猜测 coverage 应该是记录了 pytest 调用代码行数,然后从全部代码行记录中去除已经测试过行记录,就是未测试代码行,从而统计覆盖率。...,执行操作都完整显示了出来,将这些数据保存到文件中,就可以进行单元测试覆盖率统计了。...一次偶遇 coveralls 让我见识了 Python 原来还可以统计代码执行情况,真的太秀了。

53510

cargo manifest规则使用介绍

Cargo Cargo 是一个工具,允许 Rust 项目声明其各种依赖项,并确保您始终获得可重复构建。 为了实现这一目标,Cargo 做了四件事: 引入两个,包含各种项目信息元数据文件。...在这种情况下,依赖于 GitHub特定 Git 存储库。 由于以上代码未指定任何其他信息,因此 Cargo 假定我们打算使用最新提交master分支构建我们项目。...# # - 与当前可用构建状态有关徽章是 # Appveyor, CircleCI, GitLab, 和 TravisCI. # - 与代码测试覆盖有关可用徽章是 Codecov 和 #...Coveralls. # - 还有基于 isitmaintained.com维护相关徽章 # 其中说明了问题解决时间,未决问题百分比和未来 # 维护意图。...", branch = "master", service = "github" } # Coveralls: `repository` 是必须.

1.7K64

如何做好一个开源项目徽章(二)

什么是项目徽章? 我们辛苦维护自己开源项目,但是如何能够简要向其他人描述一些项目的相关信息呢?文字、代码表达方式都是有限,篇幅过多的话,增加阅读难度又使访问者无法聚焦。...项目徽章是根据项目情况生成一些小图标,一般在Readme.md里面通过Markdown语法进行添加。这些图标一般简洁美观,而且还包含项目相关一些清晰易读信息。...点击图标,就可以设置自己参数(比如用户名和仓库名),然后生成徽章了,如下图所示: ? 操作非常简单,而且还可以自定义整个徽章。 如何添加持续集成徽章?...如下图Magicodes.IE徽章所示,如何添加这些徽章呢? ? CI徽章是很有必要,一目了然了解了项目代码覆盖率、构建状态和单元测试状况,那么如何来装这个B呢?...代码覆盖率、单元测试状况呢?这个就要回到刚才Shields站点了: ? ? 如何添加贡献者徽章

62220

Jest进阶:接入ts、集成测试与覆盖率统计

集成测试 持续继承测试我们借助 https://travis-ci.org/ 这个平台,它工作流程非常简单: 在它平台上授权 github 仓库权限,github 仓库下配置 .travis.yml...文件 每次 commit 推上新代码时候,travis-ci 平台都会接收到通知 读取 .travis.yml 文件,然后创建一个虚拟环境,来跑配置好脚本(比如启动测试脚本) 它优点在于,测试代码推上去后...覆盖率统计 覆盖率统计也很简单(本来以为会很难),但是要安装 coveralls 这个库。除此之外,还要修改一下 package.json 中 scripts 指令。...剩下要做就是,登陆 coveralls.io 平台,授权 github 仓库权限。当你在 travis 平台运行上述 scripts 脚本时候,它就自动把结果扔到了 coveralls.io 平台。...IO JavaScript Document:https://docs.coveralls.io/javascript 第三方库 node-coveralls:https://github.com/nickmerwin

2.6K20

从0开始发布一个无依赖、高质量键盘npm包

开始 具体代码移步github(https://github.com/simbawus/DigitalKeyboard),请反手 给个 ★ Star ^_~。...也可以放上项目所在github地址及作者名,description和keywords比较利于SEO,不过这些都不是必需项。 到这里,一个npm包就开发完成了,直接发布即可使用。...; istanbul:代码覆盖率计算工具; coveralls:统计上面的代码测试覆盖率工具; travis-ci:自动集成,比如master代码push到github上之后,travis-ci就会自动进行自动化测试...完善README.md 一个好readme是决定用户用不用你项目的关键因素,所以要多花点心思,千万不能忽略。 标题:直观描述这个项目是干什么徽章: ?...分别表示是否构建成功、代码测试覆盖率、npm版本号、下载量、开源证书,看起来逼格满满有木有。推荐去shields io 添加,生成一次,之后会自动更新,不过需要等npm发布后才能搜到。

63310

怎样让开源项目看起来“高大上”

在我个人看来,一个“高大上” Github开源项目应该满足这些条件: 一句话说明项目的功能; 有相对完善测试用例和较高代码覆盖率; 通过徽章明确地指出项目的兼容性、最新版本、被使用情况、License...除了测试用例是否通过外,测试代码覆盖率也是一个很重要指标。...我们也可以通过持续集成方式,在 .travis.yml 文件中添加相关字段说明,从而在 codecov 等网站上自动检测 diamante 覆盖率,从而再领取一枚徽章。 个性化徽章 ?...这里强烈推荐 http://shields.io/ 这个网址,通过它,我们可以为项目添加上各种各样徽章,例如: 项目的最新版本; 项目的被使用情况; 项目的兼容情况; 测试是否通过以及代码覆盖率情况;...这里有一篇 GitHub 项目徽章添加和设置 详细介绍文章,我就不多说了,大家赶快用起来吧 :smile: 规范提交记录和更新说明 规范提交记录和更新说明,既可以让使用者清楚地知道更新内容从而有更强意愿进行升级

69210

怎样让开源项目看起来“高大上”

在我个人看来,一个“高大上” Github开源项目应该满足这些条件: 一句话说明项目的功能; 有相对完善测试用例和较高代码覆盖率; 通过徽章明确地指出项目的兼容性、最新版本、被使用情况、License...除了测试用例是否通过外,测试代码覆盖率也是一个很重要指标。...我们也可以通过持续集成方式,在 .travis.yml 文件中添加相关字段说明,从而在 codecov 等网站上自动检测 diamante 覆盖率,从而再领取一枚徽章。...这里强烈推荐 http://shields.io/ 这个网址,通过它,我们可以为项目添加上各种各样徽章,例如: 项目的最新版本; 项目的被使用情况; 项目的兼容情况; 测试是否通过以及代码覆盖率情况;...这里有一篇 GitHub 项目徽章添加和设置 详细介绍文章,我就不多说了,大家赶快用起来吧 :smile: 规范提交记录和更新说明 ---- 规范提交记录和更新说明,既可以让使用者清楚地知道更新内容从而有更强意愿进行升级

77240

组织内如何评估 CICD 成熟度

参照这些最佳实践标准项目可以进行自认证, 以获得核心基础设施促进会(CII)徽章。...帮助新项目找到那些它们要遵循最佳实践 帮助用户了解哪些项目遵循了最佳实践(这样用户可以更倾向于选择此类项目)。 最佳实践包含以下五个标准:基本,变更控制,报告,质量,安全,分析。...如果你项目GitHub 上或是你可以按照上述徽章计划进行评估,就可以使用它来评估你项目的最佳实践,并可以在项目主页 README 上显示徽章结果。...定制最佳实践标准 如果上述项目不能满足你评估要求,结合我实践,制定了如下“最佳实践标准”并分配了相应成熟度徽章,供参考。...10 Jenkins:支持获得代码覆盖率 安全 漏洞扫描 10 Jenkins:支持触发漏洞扫描 License扫描 10 Jenkins:支持触发证书扫描 分析 Code Lint 10 Jenkins

70630

从0开始发布一个无依赖、高质量npm

Demo: 开始 具体代码移步github,请反手 给个 ★ Star ^_~。...也可以放上项目所在github地址及作者名,description和keywords比较利于SEO,不过这些都不是必需项。 到这里,一个npm包就开发完成了,直接发布即可使用。...; istanbul:代码覆盖率计算工具; coveralls:统计上面的代码测试覆盖率工具; travis-ci:自动集成,比如master代码push到github上之后,travis-ci就会自动进行自动化测试...完善README.md 一个好readme是决定用户用不用你项目的关键因素,所以要多花点心思,千万不能忽略。 标题:直观描述这个项目是干什么。...徽章: 分别表示是否构建成功、代码测试覆盖率、npm版本号、下载量、开源证书,看起来逼格满满有木有。推荐去shields io 添加,生成一次,之后会自动更新,不过需要等npm发布后才能搜到。

8910

从0开始发布一个无依赖、高质量键盘npm包

开始 具体代码移步github,请反手 给个 ★ Star ^_~。...也可以放上项目所在github地址及作者名,description和keywords比较利于SEO,不过这些都不是必需项。 到这里,一个npm包就开发完成了,直接发布即可使用。...; istanbul:代码覆盖率计算工具; coveralls:统计上面的代码测试覆盖率工具; travis-ci:自动集成,比如master代码push到github上之后,travis-ci就会自动进行自动化测试...完善README.md 一个好readme是决定用户用不用你项目的关键因素,所以要多花点心思,千万不能忽略。 标题:直观描述这个项目是干什么徽章: ?...分别表示是否构建成功、代码测试覆盖率、npm版本号、下载量、开源证书,看起来逼格满满有木有。推荐去shields io 添加,生成一次,之后会自动更新,不过需要等npm发布后才能搜到。

61240

从0开始发布一个无依赖、高质量npm

开始 具体代码移步github,请反手 给个 ★ Star ^_~。...也可以放上项目所在github地址及作者名,description和keywords比较利于SEO,不过这些都不是必需项。 到这里,一个npm包就开发完成了,直接发布即可使用。...; istanbul:代码覆盖率计算工具; coveralls:统计上面的代码测试覆盖率工具; travis-ci:自动集成,比如master代码push到github上之后,travis-ci就会自动进行自动化测试...完善README.md 一个好readme是决定用户用不用你项目的关键因素,所以要多花点心思,千万不能忽略。 标题:直观描述这个项目是干什么徽章: ? ? ? ? ?...分别表示是否构建成功、代码测试覆盖率、npm版本号、下载量、开源证书,看起来逼格满满有木有。推荐去shields io 添加,生成一次,之后会自动更新,不过需要等npm发布后才能搜到。

1K10

【5min+】为你.NET应用进行一次全方位体检

它所包含了.net体系中可能会涉及到方方面面,比如C#小细节,AspnetCore,微服务中.net知识等等。...但是“出来混迟早是要还”,假如是一个长期运行项目,越早发现bug是越关键一件事,这将关系到项目后期能否稳定运行下去。 注意!!!,哪怕代码覆盖率达到了100%,也不是证明项目就不会出现bug了。...徽章收集 不知道有没有人像一样,很喜欢点QQ图标之类东西。(所以我在博客园添加了两个徽章?) 当然,使用徽章的话可以让用户一下就了解到项目的情况,比如版本号,下载数量,开源协议等等。 ?...选择您所需要添加徽章类别,这里咱们选择了Azure Coverage: ? 进行输入对应信息后,就可以获取到刚才咱们job中所得到代码覆盖率结果了。...测试通过之后再提交代码Github,然后Azure Devops进行构建。 好啦,今天内容有些多,但是对您开发.NET Core项目来说的话,是实实在在有用。

57430

【5min+】为你.NET应用进行一次全方位体检

它所包含了.net体系中可能会涉及到方方面面,比如C#小细节,AspnetCore,微服务中.net知识等等。...通过本篇文章您将Get: 为.NET Core应用添加单元测试 为.NET Core应用进行代码覆盖率度量 使用Azure Devops进行自动化构建 收获类似于下面的这些徽章: [x] 时长为大约有十分钟...但是“出来混迟早是要还”,假如是一个长期运行项目,越早发现bug是越关键一件事,这将关系到项目后期能否稳定运行下去。 注意!!!,哪怕代码覆盖率达到了100%,也不是证明项目就不会出现bug了。...徽章收集 不知道有没有人像一样,很喜欢点QQ图标之类东西。(所以我在博客园添加了两个徽章) 当然,使用徽章的话可以让用户一下就了解到项目的情况,比如版本号,下载数量,开源协议等等。...测试通过之后再提交代码Github,然后Azure Devops进行构建。 好啦,今天内容有些多,但是对您开发.NET Core项目来说的话,是实实在在有用。

59610

玩转 Github 徽章

我们会发现 Github很多项目的首页都有很多徽章。如 vue ? vue react ? react 这些徽章有什么用呢?下面我就细细道来。...聊天室功能 我们如果希望和某个 Github 项目开发者沟通,比如给这个项目提个 bug 之类。传统方式是在该项目创建一个 issue ,等开发者看到后(可能是很久之后~),回复该 issue。...但是,如果你希望进行实时进行沟通,能有个聊天室就好了~ Gitter 就提供了聊天室功能。开发者用 Github 帐号登录后,可以就为某个项目创建一个聊天室。...代码质量 如果你是一个对自己项目要求比较高开发者,那么,你肯定会为你代码写测试。 Travis Ci 提供了持续集成功能。...即,你每次提交代码,都会跑一遍测试,如果测试通过,则显示 passing, 否则 显示 failure 。 Codecov 提供了统计代码测试覆盖率功能。

71820

C++最佳实践 | 1. 工具

,已隐式应用多个用户定义转换 不建议 /Wall 会对标准库中包含文件发出警告,有太多额外警告,因此没什么用。...源代码可以在Github[66]上找到。 运行时检查 代码覆盖率分析 覆盖率分析工具应该在测试执行时运行,以确保整个应用程序都被测到。...Gcovr[70] kcov[71] 可与codecov和coveralls集成 不需要特殊编译器flag,只需要debug符号,就可以输出代码覆盖率报告 OpenCppCoverage[72] Windows...这些工具都使用覆盖率报告来寻找新代码执行路径,并尝试为代码提供新输入。它们可以发现崩溃、挂起以及一些没有被考虑到输入。...单元测试 单元测试针对是可以独立测试代码块和独立功能。 集成测试 对于提交每个特性或bug修复,都应该启用测试。参见上文介绍代码覆盖率分析。

3.2K10
领券