README

属性查询助手

入门

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

已经是专家？只需编辑此README.md并将其设置为您的个人版本。想要让它变得简单？请使用底部模板！

添加您的文件

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

集成您的工具

• [ ] [设置项目集成](https://gitlab.com/-/experiment/new_project_readme_content:b6dc236793009806b17b02d8809c9c9e?https://gitlab.com/SylwesterKowal/attributes-query/-/settings/integrations)

与您的团队协作

• [ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:b6dc236793009806b17b02d8809c9c9e?https://docs.gitlab.com/ee/user/project/members/)
• [ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:b6dc236793009806b17b02d8809c9c9e?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
• [ ] [自动关闭合并请求中的问题](https://gitlab.com/-/experiment/new_project_readme_content:b6dc236793009806b17b02d8809c9c9e?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
• [ ] [启用合并请求审批](https://gitlab.com/-/experiment/new_project_readme_content:b6dc236793009806b17b02d8809c9c9e?https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
• [ ] [在管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:b6dc236793009806b17b02d8809c9c9e?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:b6dc236793009806b17b02d8809c9c9e?https://docs.gitlab.com/ee/ci/quick_start/index.html)
• [ ] [使用静态应用程序安全测试(SAST)分析您的代码以查找已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:b6dc236793009806b17b02d8809c9c9e?https://docs.gitlab.com/ee/user/application_security/sast/)
• [ ] [使用自动部署部署到Kubernetes、Amazon EC2或Amazon ECS](https://gitlab.com/-/experiment/new_project_readme_content:b6dc236793009806b17b02d8809c9c9e?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
• [ ] [使用基于拉的部署以改善Kubernetes管理](https://gitlab.com/-/experiment/new_project_readme_content:b6dc236793009806b17b02d8809c9c9e?https://docs.gitlab.com/ee/user/clusters/agent/)
• [ ] [设置受保护的环境](https://gitlab.com/-/experiment/new_project_readme_content:b6dc236793009806b17b02d8809c9c9e?https://docs.gitlab.com/ee/ci/environments/protected_environments.html)

编辑此README

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

良好的README建议

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

名称

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

描述

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

徽章

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

视觉

根据你正在制作的内容，包括截图或甚至视频（你通常会看到GIF而不是实际的视频）。ttygif等工具可以帮助，但检查Asciinema以获取更复杂的方法。

安装

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

使用

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

支持

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

路线图

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

贡献

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

对于那些想要对您的项目进行修改的人来说，有一份如何开始的文档非常有帮助。也许他们需要运行一个脚本或者设置一些环境变量。将这些步骤明确化。这些说明对未来的您也可能有用。

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

作者和致谢

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

许可协议

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

项目状态

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