m8ty / video-games-bundle
视频游戏管理器
Requires
- m8ty/admin-bundle: dev-master
This package is auto-updated.
Last update: 2024-09-23 03:41:59 UTC
README
入门
为了帮助您在 GitLab 上快速开始，以下是一些推荐的操作步骤。
已经是老手？只需编辑此 README.md 文件，并使其成为您自己的。想要简化操作？请使用底部的模板！
添加您的文件
- [ ] [创建](https://gitlab.com/-/experiment/new_project_readme_content:b57e912e9cd2573ef08ab1fba8e7a129?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file)或上传文件
- [ ] [使用命令行添加文件](https://gitlab.com/-/experiment/new_project_readme_content:b57e912e9cd2573ef08ab1fba8e7a129?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/m8ty/video-games-bundle.git
git branch -M main
git push -uf origin main
与您的工具集成
与您的团队协作
- [ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:b57e912e9cd2573ef08ab1fba8e7a129?https://docs.gitlab.com/ee/user/project/members/)
- [ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:b57e912e9cd2573ef08ab1fba8e7a129?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [自动关闭合并请求中的问题](https://gitlab.com/-/experiment/new_project_readme_content:b57e912e9cd2573ef08ab1fba8e7a129?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [启用合并请求审批](https://gitlab.com/-/experiment/new_project_readme_content:b57e912e9cd2573ef08ab1fba8e7a129?https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:b57e912e9cd2573ef08ab1fba8e7a129?https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
测试和部署
使用 GitLab 内置的持续集成。
- [ ] [开始使用 GitLab CI/CD](https://gitlab.com/-/experiment/new_project_readme_content:b57e912e9cd2573ef08ab1fba8e7a129?https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [使用静态应用安全测试(SAST)分析您的代码以查找已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:b57e912e9cd2573ef08ab1fba8e7a129?https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [使用自动部署将应用部署到 Kubernetes、Amazon EC2 或 Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:b57e912e9cd2573ef08ab1fba8e7a129?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [使用基于拉的部署以改善Kubernetes管理](https://gitlab.com/-/experiment/new_project_readme_content:b57e912e9cd2573ef08ab1fba8e7a129?https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [设置受保护的环境](https://gitlab.com/-/experiment/new_project_readme_content:b57e912e9cd2573ef08ab1fba8e7a129?https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
编辑此README
当你准备好将此README变为自己的时，只需编辑此文件并使用下方的便捷模板（或者您也可以随意结构化它 - 这只是一个起点！）感谢makeareadme.com提供的此模板。
优秀的README建议
每个项目都是不同的，所以请考虑哪些部分适用于您的项目。模板中使用的部分是大多数开源项目的建议。同时请记住，虽然README可以太长且详细，但比太短要好。如果您认为您的README太长，请考虑利用其他形式的文档而不是删除信息。
名称
为您的项目选择一个自解释的名称。
描述
让人们知道您的项目具体能做什么。提供上下文并添加任何可能不熟悉的参考链接。也可以在此处添加功能列表或背景子部分。如果您的项目有替代品，这是一个列出不同因素的好地方。
徽章
在一些README中，您可能会看到一些小图像，传达元数据，例如项目是否所有测试都通过。您可以使用盾牌添加一些到您的README中。许多服务也有添加徽章的说明。
视觉元素
根据您正在创建的内容，包括截图甚至视频（您通常会看到GIF而不是实际视频）可能是个好主意。像ttygif这样的工具可能会有所帮助，但请检查Asciinema以获取更复杂的方法。
安装
在特定的生态系统内，可能有安装东西的常见方式，例如使用Yarn、NuGet或Homebrew。但是，请考虑阅读您的README的人可能是一位新手，并希望获得更多指导。列出具体步骤有助于消除歧义，并尽快让人们开始使用您的项目。如果它仅在特定上下文中运行，例如特定的编程语言版本、操作系统或需要手动安装的依赖项，请添加一个“要求”子部分。
使用
大量使用示例，并在可能的情况下展示预期的输出。如果示例太长而无法合理包含在README中，提供更多复杂示例的链接也很有用。
支持
告诉人们他们可以到哪里寻求帮助。可以是任何组合的问题跟踪器、聊天室、电子邮件地址等。
路线图
如果您对未来发布有想法，将其列在README中是个好主意。
贡献
说明您是否接受贡献以及接受它们的要求。
对于想要更改您项目的人来说，有关如何开始的一些文档会有所帮助。可能有一个他们应该运行的脚本或他们需要设置的一些环境变量。明确这些步骤。这些说明也可能对您的未来自己有用。
您还可以记录用于代码检查或运行测试的命令。这些步骤有助于确保代码质量高，并降低无意中破坏某物的可能性。如果测试需要外部设置，例如在浏览器中进行测试时启动Selenium服务器，那么提供运行测试的说明特别有帮助。
作者和致谢
感谢那些为项目做出贡献的人。
许可证
对于开源项目，说明其许可方式。
项目状态
如果您在项目中耗尽了精力或时间，请在README文件顶部注明开发已放缓或已完全停止。有人可能会选择分支您的项目，或者志愿担任维护者或所有者，以使您的项目继续进行。您还可以明确提出对维护者的请求。