ja_python_template

入门指南

为了帮助您轻松开始使用GitLab，以下是一些建议的下一步操作。

已经是专家？只需编辑此README.md并将其作为您自己的。想让它变得简单？使用底部的模板！

添加您的文件

• 创建或上传文件
• 使用命令行添加文件或使用以下命令推送现有的Git仓库

cd existing_repo
git remote add origin https://git.ligo.org/ja_project_templates/ja_python_template.git
git branch -M main
git push -uf origin main

与您的工具集成

• 设置项目集成
• 编辑pyproject.toml（至少：需要关注'?'）

与您的团队协作

• 邀请团队成员和协作者
• 创建一个新的合并请求
• 自动关闭合并请求中的问题
• 启用合并请求审批
• 设置自动合并

测试和部署

使用GitLab内置的持续集成。

• 开始使用GitLab CI/CD
• 使用静态应用安全测试 (SAST) 分析代码中的已知漏洞
• 使用自动部署将应用程序部署到Kubernetes、Amazon EC2或Amazon ECS
• 使用基于拉的部署来提高Kubernetes管理
• 设置受保护的环境

编辑此README

当您准备好将此README作为您自己的文档时，只需编辑此文件并使用下面的便捷模板（或者您可以自由地按自己的方式结构化它——这只是一个起点！）感谢makeareadme.com提供此模板。

优秀的README建议

每个项目都是不同的，因此请考虑哪些部分适用于您的项目。模板中使用的部分是大多数开源项目的建议。同时请注意，虽然README可能太长且详细，但过长总比过短好。如果您认为您的README太长，考虑使用另一种形式的文档，而不是删除信息。

名称

为您的项目选择一个自我解释的名称。

描述

让人们知道您的项目具体能做什么。提供上下文并添加链接到可能不熟悉的参考内容。也可以在此处添加功能列表或背景子部分。如果您的项目有替代品，这是一个列出不同因素的好地方。

徽章

在某些README中，您可能会看到传达元数据的小图像，例如项目是否所有测试都通过。您可以使用Shields在README中添加一些徽章。许多服务也提供了添加徽章的说明。

视觉元素

根据您正在制作的内容，包含截图甚至视频（您通常会看到GIF而不是实际视频）可能是个好主意。ttygif等工具可以帮助，但请检查Asciinema以获取更高级的方法。

安装

在特定生态系统中，可能存在安装事物的常见方式，例如使用Yarn、NuGet或Homebrew。但是，请考虑阅读您的README的人可能是一个新手，并希望获得更多指导。列出具体步骤有助于消除歧义，并尽快让人们开始使用您的项目。如果它仅在特定上下文中运行，例如特定的编程语言版本或操作系统，或者有必须手动安装的依赖项，请添加一个要求子部分。

使用

广泛使用示例，并在可能的情况下展示预期输出。包含您能展示的最小使用示例非常有帮助，同时提供链接到更复杂的示例，如果它们太长而无法合理地包含在README中。

支持

告诉人们他们可以去哪里寻求帮助。可以是任何组合的问题跟踪器、聊天室、电子邮件地址等。

路线图

如果您对未来发布有想法，将它们列在README中是个好主意。

贡献

说明您是否欢迎贡献以及接受贡献的要求。

对于想要更改您项目的人来说，有一些关于如何开始的文档可能会有所帮助。也许有一些他们应该运行的脚本，或者一些他们需要设置的环境变量。明确这些步骤。这些说明也可能对您未来的自己有用。

您还可以记录用于检查代码或运行测试的命令。这些步骤有助于确保代码质量高，并减少更改意外破坏东西的可能性。如果运行测试需要外部设置，例如在浏览器中进行测试时启动Selenium服务器，那么运行测试的说明尤其有用。

作者和致谢

向为项目做出贡献的人表示感谢。

许可证

对于开源项目，说明其许可方式。

项目状态

如果你的项目耗尽了能量或时间，请在README顶部添加一条备注，说明开发已放缓或完全停止。有人可能会选择fork你的项目或自愿成为维护者或所有者，以使你的项目继续进行。你也可以明确要求维护者。