Salt Extension for Telegram

Salt与Telegram交互的扩展

安全

如果您发现安全漏洞，请参阅 Salt的安全指南。

用户文档

有关设置和使用说明，请参阅 用户文档。

贡献

saltext-telegram项目欢迎任何人的贡献！

Salt Extensions指南 提供了关于Salt扩展开发的全面说明，包括 编写测试、运行测试、编写文档 和 渲染文档。

快速入门

要开始贡献，首先克隆此存储库（或您的分支）

# Clone the repo
git clone --origin upstream git@github.com:salt-extensions/saltext-telegram.git

# Change to the repo dir
cd saltext-telegram

自动

如果您已安装 direnv，允许项目的 .envrc 确保存在适当的开发生态，并激活虚拟环境。

没有 direnv，您仍然可以显式运行自动化

python3 tools/initialize.py
source .venv/bin/activate

手动

请按照第一步进行操作，跳过仓库初始化和首次提交。

拉取请求

始终在功能分支中进行更改

git switch -c my-feature-branch

要提交拉取请求，您需要在自己的GitHub账户中有一个此仓库的分支。如果您按照上述说明操作，现在将您的分支设置为origin远程

git remote add origin git@github.com:<your_fork>.git

确保您已按照第一步进行操作，并提交了更改，修复了任何失败的pre-commit钩子。然后将功能分支推送到您的分支并提交PR。

贡献方式

贡献有多种形式，它们都很有价值！以下是一些您可以在不编写代码的情况下提供帮助的方式

• 文档：特别是展示如何使用此项目解决特定问题的示例。
• 问题分类：帮助管理问题并参与讨论。
• 审阅拉取请求：我们特别欣赏使用Conventional Comments进行的审阅。

您还可以通过以下方式贡献

• 撰写博客文章
• 在社交媒体上分享您使用Salt + Telegram的经验
• 在会议上发表演讲
• 发布视频
• 参与IRC、Discord或电子邮件组

以上任何一种方式对我们社区来说都非常有价值，我们真诚地感谢每一个贡献！