PyMBSE 优化

与 PyMBSE 兼容的优化算法项目

入门

为了让您更轻松地开始使用 GitLab，以下是推荐的后续步骤列表。

已经是专业人士了？只需编辑此 README.md 并使其成为您自己的。想让它变得容易吗？使用底部的模板！

添加您的文件

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

cd existing_repo
git remote add origin https://gitlab.ethz.ch/magnum/pymbse-optim.git
git branch -M main
git push -uf origin main

与您的工具集成

• 设置项目集成

与您的团队合作

• 邀请团队成员和合作者
• 创建一个新的合并请求
• 自动关闭来自合并请求的问题
• 启用合并请求批准
• 管道成功时自动合并

测试和部署

使用 GitLab 中内置的持续集成。

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

编辑此自述文件

当您准备好自己的 README 时，只需编辑此文件并使用下面的方便模板（或随意按照您的需要构建它 - 这只是一个起点！）。感谢makeareadme.com提供此模板。

对好的 README 的建议

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

姓名

为您的项目选择一个不言自明的名称。

描述

让人们知道您的项目可以具体做什么。提供上下文并添加指向访问者可能不熟悉的任何参考的链接。也可以在此处添加功能列表或背景小节。如果您的项目有替代方案，这是列出差异化因素的好地方。

徽章

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

视觉效果

根据您制作的内容，最好包含屏幕截图甚至视频（您会经常看到 GIF，而不是实际视频）。像 ttygif 这样的工具可以提供帮助，但请查看 Asciinema 以获得更复杂的方法。

安装

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

用法

自由地使用示例，并尽可能显示预期的输出。内联您可以演示的最小用法示例会很有帮助，同时如果它们太长而无法合理地包含在自述文件中，则提供指向更复杂示例的链接。

支持

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

路线图

如果您对未来的发布有想法，最好将它们列在自述文件中。

贡献

说明您是否愿意接受捐款以及接受捐款的要求。

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

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

作者和致谢

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

执照

对于开源项目，说明它是如何获得许可的。

项目状态

如果您的项目已经耗尽精力或时间，请在 README 顶部添加注释，说明开发已放缓或完全停止。有人可能会选择分叉你的项目或自愿作为维护者或所有者介入，让你的项目继续进行。您还可以向维护者提出明确的请求。