README

入门

为了帮助您轻松开始使用GitLab，以下是推荐的下一步操作列表。

已经是专家？只需编辑此README.md，使其成为您自己的。想让它变得简单？使用下面的模板！

添加您的文件

• [ ] [创建](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或 上传 文件
• [ ] [使用命令行添加文件](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?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/centersisopen/Financeiro.git
git branch -M main
git push -uf origin main

与您的工具集成

• [ ] [设置项目集成](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/user/project/integrations/)

与您的团队协作

• [ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/user/project/members/)
• [ ] [创建一个新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
• [ ] [自动从合并请求关闭问题](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
• [ ] [当管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?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:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/ci/quick_start/index.html)
• [ ] [使用静态应用程序安全测试(SAST)分析代码中的已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:bc1886e48f557849b33f74f7d283f8da?https://docs.gitlab.com/ee/user/application_security/sast/)

编辑此README

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

良好README的建议

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

名称

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

描述

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

徽章

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

视觉内容

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

安装

在特定的生态系统内，可能存在安装东西的常见方式，例如使用Yarn、NuGet或Homebrew。然而，考虑到阅读您的README的人可能是一位新手，他们可能需要更多指导。列出具体步骤有助于消除歧义，并尽快让人们开始使用您的项目。如果它只在特定的上下文中运行，比如特定的编程语言版本或操作系统，或者有需要手动安装的依赖项，也可以添加一个要求子部分。

使用

大量使用示例，并在可能的情况下展示预期的输出。如果它们太长而无法合理地包含在README中，提供链接到更复杂的示例很有帮助。

支持

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

路线图

如果您对未来发行版有想法，将其列在README中是个好主意。

贡献

说明您是否接受贡献以及接受它们的要求。

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

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

作者和致谢

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

许可

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

项目状态

如果您在项目上耗尽了精力或时间，请在README的顶部注明开发已放缓或完全停止。某人可能选择分支您的项目或志愿成为维护者或所有者，使项目继续进行。您也可以明确请求维护者。