koválny/twig_link_attributes

无维护者的贡献模块修补版本。

安装: 411

依赖者: 0

建议者: 0

安全: 0

星级: 0

分支: 0

类型:drupal自定义模块

1.0.0 2021-08-13 11:25 UTC

This package is auto-updated.

Last update: 2024-09-14 01:09:38 UTC


README

修补版本,用于调整twig属性。已死去的Drupal项目

开始使用

为了帮助您开始使用GitLab,以下是一些推荐的下一步操作。

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

添加您的文件

cd existing_repo
git remote add origin https://gitlab.com/kwall/twig-link-attributes.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中列出它们。

贡献

说明您是否欢迎贡献以及接受贡献的要求。

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

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

作者和致谢

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

许可

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

项目状态

如果您已耗尽为项目提供能量或时间,请在README的顶部添加一条说明,表示开发已减慢或已完全停止。有人可能会选择fork您的项目或自愿担任维护者或所有者,从而使您的项目继续发展。您还可以明确请求维护者。