搜索m8ty / media-bundle
媒体管理器
Requires
- m8ty/admin-bundle: dev-master
This package is not auto-updated.
Last update: 2024-10-03 09:07:08 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中，您可能会看到传达元数据的小图像，例如项目是否所有测试都通过。您可以使用Shields在README中添加一些。许多服务也提供了添加徽章的说明。
视觉效果
根据您所制作的内容，包含截图甚至视频可能是一个好主意（您通常会看到GIF而不是实际视频）。像ttygif这样的工具可能会有所帮助，但请检查Asciinema以获得更复杂的方法。
安装
在特定的生态系统中，可能存在一种常见的安装方法，例如使用Yarn、NuGet或Homebrew。但是，请考虑阅读您的README的人可能是一个新手，并且希望获得更多指导。列出具体步骤有助于消除歧义，并尽快让人们使用您的项目。如果它仅在特定环境中运行（例如特定编程语言版本或操作系统）或需要手动安装依赖项，也可以添加一个需求子部分。
使用
自由使用示例，并在可能的情况下展示预期的输出。包含您能展示的最小使用示例很有帮助，同时提供链接到更复杂的示例，如果它们太长而无法合理包含在README中。
支持
告诉人们他们可以去哪里寻求帮助。它可以是问题跟踪器、聊天室、电子邮件地址等的任何组合。
路线图
如果您对未来发布有任何想法，将它们列在README中是一个好主意。
贡献
说明您是否接受贡献以及接受它们的要求。
对于想要更改您项目的人来说，有一些如何开始的文档可能会有所帮助。也许有一些他们应该运行的脚本或需要设置的一些环境变量。明确这些步骤。这些说明也可能对您的未来自己有用。
您还可以记录用于代码检查或运行测试的命令。这些步骤有助于确保代码质量高，并降低意外破坏东西的可能性。如果测试需要外部设置，如启动Selenium服务器进行浏览器测试，拥有运行测试的说明特别有帮助。
作者和致谢
向为项目做出贡献的人表示感谢。
许可协议
对于开源项目，说明其许可方式。
项目状态
如果您在项目上耗尽了精力或时间，请在README的最顶部添加一条注释，说明开发已放缓或已完全停止。有人可能会选择分叉您的项目或自愿担任维护者或所有者，让您的项目继续进行。您也可以明确请求维护者。