如何为项目编写良好 README (quickapp.lovejade.cn)

【简介】

README,它是别人对项目了解、印象的第一来源;尤其是针对开源项目,相当之重要:好比颜值之于一个人,主页之于一个公司;但很多项目并未重视这一点;各种仓库,浩如烟海,没有简洁、明晰的介绍,教人如何耐心去看?本篇文章的存在,即是为了改善这种情况。它将指导您如何写出一篇友好、易读的 README ,同时提供一键生成专业 README(模版)的工具,从而为广大开发者,解决如何书写良好 README 之烦忧;同时为诸多阅读者,缓解没有清晰 README 一窥项目主旨的苦恼。

点击查看全文 >>

@杨琼璞 2020-01-16 20:59分享 / 0个评论
赞过的人: 曼妙句子 杨轩帅 技术头条 IT技术博客大学习 杨琼璞
要不要再学学下面的文章?
Vue项目打包部署总结 (mp.weixin.qq.com)
使用Vue做前后端分离项目时,通常前端是单独部署,用户访问的也是前端项目地址,因此前端开发人员很有必要熟悉一下项目部署的流程与各类问题的解决办法了。
by @code小生 2022-08-07 09:40 分享 查看详情
数据仓库项目从来不是技术项目 (insights.thoughtworks.cn)
本文提供了一个从落地实施角度观察数据仓库的视角,数据仓库并不是简单的技术组件堆砌,使数据仓库产生价值更需要会“掘金”。
by @Thoughtworks 2022-07-26 11:11 分享 查看详情
SpringBoot项目瘦身指南! (mp.weixin.qq.com)
Spring Boot部署起来虽然简单,如果服务器部署在公司内网,速度还行,但是如果部署在公网,部署起来实在头疼:编译出来的 Jar 包很大,如果工程引入了许多开源组件(Spring Cloud等),那就更大了。
by @code小生 2022-07-24 10:59 分享 查看详情
SpringBoot这样优化,让你的项目飞起来! (mp.weixin.qq.com)
针对上述的优化点来说,首先线程数是一个重点,初始线程数和最大线程数,初始线程数保障启动的时候,如果有大量用户访问,能够很稳定的接受请求。

而最大线程数量用来保证系统的稳定性,而超时时间用来保障连接数不容易被压垮,如果大批量的请求过来,延迟比较高,不容易把线程打满。这种情况在生产中是比较常见的 ,一旦网络不稳定,宁愿丢包也不愿意把机器压垮。
by @code小生 2022-06-26 11:32 分享 查看详情
在一个“去QA化”的项目中,QA能做什么? (insights.thoughtworks.cn)
所谓“去QA化”只是在某些项目中去掉了单独的一个QA角色,但是总有人会戴上QA的帽子,或者人人都戴上了QA的帽子,人人都拥有很高的质量意识,这其实是QA的理想国。
by @Thoughtworks 2022-06-07 14:27 分享 查看详情
编写可维护的Go代码 (colobu.com)
编写可维护的代码是最基本的要求。清晰度、可读性和简单性都是保持代码可维护性的各个方面。它应该使某人加入您的项目或在有人离开后维护代码的过程变得容易。可维护性的衡量指标是代码更改的容易程度以及与这些更改引起的风险性。为了有效地编写Go程序,了解Go语言的属性和地道写法,并使用与命名、程序构建、格式等相关既定约定是至关重要。

本文是一些有助于编写可维护的Go代码的良好实践。
by @技术头条 2022-05-23 00:05 分享 查看详情
编写可维护的Go代码 (colobu.com)
编写可维护的代码是最基本的要求。清晰度、可读性和简单性都是保持代码可维护性的各个方面。它应该使某人加入您的项目或在有人离开后维护代码的过程变得容易。可维护性的衡量指标是代码更改的容易程度以及与这些更改引起的风险性。为了有效地编写Go程序,了解Go语言的属性和地道写法,并使用与命名、程序构建、格式等相关既定约定是至关重要。

本文是一些有助于编写可维护的Go代码的良好实践。
by @技术头条 2022-05-23 00:05 分享 查看详情
一款微信小程序商城项目(附源码) (mp.weixin.qq.com)
这是我目前见过的最好的小程序商城项目。功能完整,代码结构清晰。值得推荐。
后端部分虽然是PHP的,但是建议有研究精神的朋友完全可以重构成Java版本,自己搭建框架的能力也就锻炼出来了!
by @code小生 2022-05-08 23:45 分享 查看详情
编写高性能Java代码的最佳实践! (mp.weixin.qq.com)
在这篇文章中,我们将讨论几个有助于提升Java应用程序性能的方法。我们首先将介绍如何定义可度量的性能指标,然后看看有哪些工具可以用来度量和监控应用程序性能,以及确定性能瓶颈。
by @code小生 2022-05-05 23:09 分享 查看详情
关于编写故事卡的一些经验 (insights.thoughtworks.cn)
我认同故事卡里非常详细的描述可以带来价值,但我也相信“简练的表述 + 充分的沟通”可以更高效、更灵活;我认同故事卡不是契约或合同,但我也相信完整、准确的表述可以显著降低各角色间的沟通成本。
by @Thoughtworks 2022-04-24 11:48 分享 查看详情