README

入门

为了让您更容易开始使用GitLab，以下是一些推荐的下一步操作。

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

添加您的文件

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

cd existing_repo
git remote add origin https://gitlab.com/wpify/helpers.git
git branch -M main
git push -uf origin main

与您的工具集成

设置项目集成

与您的团队协作

测试和部署

使用GitLab的内置持续集成。

编辑此README

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

良好的README建议

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

名称

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

描述

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

徽章

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

视觉元素

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

安装

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

使用

广泛使用示例，并在可能的情况下展示预期的输出。提供尽可能小的使用示例，如果示例过长，无法合理地包含在README中，可以提供链接到更复杂的示例。

支持

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

路线图

如果你对未来版本有想法，将它们列在README中是个好主意。

贡献

声明你是否接受贡献以及接受贡献的要求。

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

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

作者和致谢

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

许可协议

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

项目状态

如果你在项目上耗尽了精力或时间，在README的顶部添加一条说明，说明开发已经减缓或完全停止。有人可能会选择分叉你的项目，或者志愿担任维护者或所有者，让你的项目继续进行。你还可以明确要求维护者。

wpify / helpers

维护者

详细信息