badpixxel / robo-nodejs
Robo Task Runner 的 Node JS & Yarn Actions
Requires
- php: ^7.4|^8.0
- consolidation/robo: ^4.0
Requires (Dev)
- badpixxel/php-sdk: dev-main
This package is auto-updated.
Last update: 2024-09-13 14:33:39 UTC
README
入门指南
为了帮助您轻松开始使用 GitLab,这里有一份推荐步骤列表。
已经是高手了吗?只需编辑这个 README.md 文件,让它成为您自己的。想让它变得简单?使用下面的模板!
添加您的文件
- [ ] [创建](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或 上传 文件
- [ ] [使用命令行添加文件](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) 或使用以下命令推送现有的 Git 仓库
cd existing_repo
git remote add origin https://gitlab.com/BadPixxel/robo-nodejs.git
git branch -M main
git push -uf origin main
与您的工具集成
与您的团队协作
- [ ] [邀请团队成员和协作者](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [创建新的合并请求](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [自动关闭合并请求中的问题](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [启用合并请求审批](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [管道成功时自动合并](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
测试和部署
使用 GitLab 内置的持续集成。
- [ ] [开始使用 GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [使用静态应用程序安全测试(SAST)分析您的代码中的已知漏洞](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [使用自动部署将应用程序部署到 Kubernetes、Amazon EC2 或 Amazon ECS](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [使用基于拉的部署以改进 Kubernetes 管理](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [设置受保护的环境](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
编辑此 README
当您准备好将此 README 变成您自己的时,只需编辑此文件并使用下面的便捷模板(或者您可以随意构建结构 - 这只是一个起点!)感谢 makeareadme.com 提供此模板。
良好的 README 的建议
每个项目都是不同的,因此请考虑哪些部分适用于您的项目。模板中使用的部分是大多数开源项目的建议。同时请注意,虽然README可能太长或太详细,但太长总比太短好。如果您认为您的README太长,考虑使用另一种形式的文档,而不是删除信息。
名称
为您的项目选择一个易于理解的名称。
描述
让人们知道您的项目具体能做什么。提供上下文,并添加链接到任何可能不熟悉的参考信息。也可以在此处添加功能列表或背景子部分。如果有替代项目,这也是列出不同点的良好位置。
徽章
在某些README中,您可能会看到传达元数据的小图像,例如项目是否所有测试都通过。您可以在README中使用Shields添加一些。许多服务也提供了添加徽章的说明。
视觉元素
根据您所制作的内容,包括截图甚至视频(您通常会看到GIF而不是实际视频)是个好主意。ttygif等工具可以帮助,但请检查Asciinema以获取更复杂的方法。
安装
在特定的生态系统内,可能会有安装事物的共同方式,例如使用Yarn、NuGet或Homebrew。但是,考虑到阅读您的README的人可能是个新手,可能需要更多指导。列出具体步骤有助于消除歧义,并让人们尽可能快地使用您的项目。如果它仅在特定环境中运行,如特定编程语言版本或操作系统,或者需要手动安装的依赖项,也请添加一个要求子部分。
使用方法
广泛使用示例,并在可能的情况下显示预期输出。在README中包含尽可能小的使用示例非常有帮助,同时提供链接到更复杂的示例,如果它们太长而不宜包含在README中。
支持
告诉人们他们可以到哪里寻求帮助。可以是任何组合,包括问题跟踪器、聊天室、电子邮件地址等。
路线图
如果您对未来版本有想法,将它们列在README中是个好主意。
贡献
说明您是否欢迎贡献以及接受贡献的要求。
对于想要修改您项目的人来说,有一些关于如何开始的文档是很有帮助的。可能有一个他们应该运行的脚本或他们需要设置的某些环境变量。明确这些步骤。这些说明也可能对您的未来自己有用。
您还可以记录检查代码或运行测试的命令。这些步骤有助于确保代码质量高,并降低更改意外破坏某些内容的可能性。如果需要外部设置(如启动Selenium服务器以在浏览器中测试)来运行测试,则运行测试的说明特别有用。
作者和致谢
向为项目做出贡献的人表示感谢。
许可
对于开源项目,说明其许可方式。
项目状态
如果您已耗尽对项目的精力或时间,请在README的顶部注明开发已减慢或已完全停止。有人可能会选择分支您的项目或自愿担任维护者或所有者,使项目得以继续。您还可以明确提出维护者的请求。