README

入门指南

为了方便您在GitLab中入门，以下是一些推荐的下一步操作。

已经是专家了？只需编辑此README.md文件，使其成为您自己的。想要更简单？使用底部的模板！

添加您的文件

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

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/otavio7/primeiro-pacote/-/settings/integrations)

与您的团队协作

[ ] [邀请团队成员和协作者](https://docs.gitlab.com/ee/user/project/members/)
[ ] [创建新的合并请求](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
[ ] [从合并请求自动关闭问题](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
[ ] [启用合并请求审批](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
[ ] [设置自动合并](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

测试和部署

使用GitLab内置的持续集成。

[ ] [开始使用GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
[ ] [使用静态应用程序安全测试(SAST)分析您的代码中的已知漏洞](https://docs.gitlab.com/ee/user/application_security/sast/)
[ ] [使用自动部署将应用程序部署到Kubernetes、Amazon EC2或Amazon ECS](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
[ ] [使用基于拉的部署以改进Kubernetes管理](https://docs.gitlab.com/ee/user/clusters/agent/)
[ ] [设置受保护的环境](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)

编辑此README

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

优秀README的建议

每个项目都不同，因此考虑哪些部分适用于您的项目。模板中使用的部分是大多数开源项目的建议。

名称

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

描述

让人们了解您的项目具体能做什么。提供背景信息，并添加链接到任何可能不熟悉的参考内容。也可以在这里添加功能列表或背景子部分。如果有与您的项目不同的替代品，这是一个列出不同点的良好位置。

徽章

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

视觉元素

根据您正在制作的内容，包括截图甚至视频（您通常会比实际视频更常见到GIF）。像ttygif这样的工具可以帮助，但请检查Asciinema以获取更高级的方法。

安装

composer require otavio7/primeiro-pacote;

API

namespace Otavio7\PrimeiroPacote;
class Exemplo{
    /**
     * Retorna o nome;
    */
    public function nome();
}

用法

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

支持

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

路线图

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

贡献

说明您是否愿意接受贡献以及接受贡献的要求。

对于想要修改您的项目的人来说，提供一些如何开始的文档是有帮助的。也许有一个他们应该运行的脚本或一些需要设置的运行时变量。明确这些步骤。这些说明也可能对您的未来自我有所帮助。

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

作者和致谢

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

许可证

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

项目状态

如果您已经耗尽了为项目提供能量或时间，请在README顶部注明开发已减慢或已完全停止。有人可能会选择分支您的项目或志愿担任维护者或所有者，使项目继续进行。您还可以明确请求维护者。

otavio7 / primeiro-pacote

维护者

详情