你们项目里的readme文件写了些什么?

能否把相关账号的密码写在里面?这样会不会有什么风险?

阅读 5.2k
5 个回答

readme里面写账号干啥?
太不安全了

意思就是读我。
一般就是对项目功能作简单介绍,比如:
功能、使用、依赖、兼容性、项目结构等。

写账号密码这些就不要了,这些东西都是私密,readme是给别人看的,不安全。

我会写一些 项目简介 文件结构 更新改动 比如git提交的信息我都会在readme里补充一份 这样以后merge的时候直接看readme就能知道有没有把需要的都合进来了

说说我们的项目readme,主要的目的是给新手看的,其次是项目做了什么构建上的重大变更,需要注明变更和注意事项。

新人来了,clone下项目参阅readme就可以把项目跑起来,那就基本算不错了。

推荐问题