问卷包装
开始
为了方便你从GitLab开始,这里列出了推荐的下一步步骤.
已经是职业了? 编辑这个README.md 并把它自己。 想轻松点吗? 使用底部的模板来啊!
添加您的文件
cd existing_repo
git remote add origin https://gitlab.com/aviradigital/nfinitinextgen/questionnairepackage.git
git branch -M main
git push -uf origin main
与工具结合
与你的团队合作
测试和部署
在 GitLab 中使用内置连续集成.
- 从GitLab CI/CD开始
- 用静态应用程序安全测试( SAST) 分析已知弱点的代码
- 使用自动部署部署到Kubernetes、Amazon EC2或 Amazon ECS
- 利用牵引部署改进Kubernetes管理
- 建立保护性环境
编辑此读取器
当您准备好让这个 README 成为您自己的文件时, 请编辑此文件并使用下面的方便模板( 或随便随意构造它 - 这只是一个起点 !) 。 感谢 makeareadme.com (中文(中国大陆) ) 本模板.
关于良好阅读的建议
每一个项目都是不同的,所以考虑这些章节中哪部分适用于你的. 模板中使用的章节是大多数开源项目的建议. 还铭记,虽然读取母体可能太长和详细,但太长比太短要好。 如果您认为您所读的 EADME 时间太长, 请考虑使用另一种文档形式, 而不是剪除信息 .
名称
为您的工程选择一个自我解释的名称 .
说明
让人们知道你的项目能具体做什么 提供上下文并与任何参考访问者增加链接可能不熟悉。 这里还可以添加一个地物列表或背景分节. 如果您的项目有其他选择的话, 这是个好地方列出不同的因素 .
标签
在一些 README 上,您可能看到传送元数据的小图像,例如所有测试是否都为项目通过. 您可以使用Shields来添加一些到您的 README 中. 许多服务机构也有添加徽章的指示.
视觉
根据你正在制作的作品,包含截图甚至视频(你会经常看到GIFs而不是真实的视频)是一个好主意. 像ttygif这样的工具可以有所帮助,但检查出Asciinema的更精密的方法.
安装
在特定生态系统内,可能有一个共同的安装方式,例如使用Yarn,Nuget,或Homebrew. 然而,考虑一下,任何正在读取你读取的README的人可能是一个新手,并且希望得到更多的指导. 列出具体步骤有助于消除模糊性,让人们尽快使用您的项目. 如果它只运行在像特定编程语言版本或操作系统这样的特定上下文中,或者有必须手动安装的依赖性,也添加一个要求分节.
使用量
自由使用示例,并显示预期输出。 如果使用时间太长,无法合理纳入README,那么在提供与更精密实例的链接的同时,可以将最小的用法实例进行内化,这很有帮助.
支助
告诉人们他们可以去哪里求助。 它可以是问题跟踪器,聊天室,电子邮件地址等的任何组合.
路线图
如果将来有释放的想法,最好将它们列入README.
捐款
如果您愿意捐款,请说明接受捐款的要求.
对于那些想改变你项目的人来说,拥有一些关于如何开始的文件很有帮助. 也许他们应该运行一个脚本,或者需要设置一些环境变量. 明确这些步骤。 这些指示对于你未来的自己也可能有用.
也可以记录用于添加代码或运行测试的命令。 这些步骤有助于确保高码质量并减少变化无意中打破某事的可能性. 拥有运行测试的指令如果需要外部设置,特别有帮助,例如启动一个硒服务器在浏览器中测试.
作者和承认
向为该项目捐款的人表示感谢.
许可证
对于开源项目,请说明如何获得许可.
项目状况
如果您的工程耗尽了能量或时间, 请在 README 的顶端加注, 表示开发已经放缓或完全停止 。 有人可能选择叉开您的项目,或自愿作为维护者或所有者介入,允许您的项目持续进行. 您也可明确要求维护者.