Mattermost的Salt扩展

Mattermost交互的Salt扩展

安全

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

用户文档

有关设置和使用说明，请参阅模块文档字符串（目前，文档正在准备中！）。

贡献

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

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

快速入门

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

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

# Change to the repo dir
cd saltext-mattermost

自动

如果您已安装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 + Mattermost的经验
• 在会议上发表演讲
• 发布视频
• 参与IRC、Discord或电子邮件组

以上任何一项对我们社区都非常有价值，我们真诚地感谢每一项贡献！