Salt扩展程序用于Freezer

Salt与Freezer交互的扩展

安全

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

用户文档

此README是为希望为项目做出贡献的人编写的。如果您只想开始使用此扩展，请查看模块docstrings（目前，文档正在编写中！）。

贡献

saltext-freezer项目团队欢迎社区的贡献。

有关详细信息，请参阅Salt贡献指南，但如果您想立即开始，以下是开始的方法

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

# Change to the repo dir
cd saltext-freezer

# Create a new venv
python3 -m venv env --prompt saltext-freezer
source env/bin/activate

# On mac, you may need to upgrade pip
python -m pip install --upgrade pip

# On WSL or some flavors of linux you may need to install the `enchant`
# library in order to build the docs
sudo apt-get install -y enchant

# Install extension + test/dev/doc dependencies into your environment
python -m pip install -e '.[tests,dev,docs]'

# Run tests!
python -m nox -e tests-3

# skip requirements install for next time
export SKIP_REQUIREMENTS_INSTALL=1

# Build the docs, serve, and view in your web browser:
python -m nox -e docs && (cd docs/_build/html; python -m webbrowser localhost:8000; python -m http.server; cd -)

编写代码并不是唯一的贡献方式！我们重视以下领域的贡献

• 文档 - 尤其是如何使用此模块解决特定问题的示例。
• 对问题进行分类并参与讨论
• 审查拉取请求（我们真的很喜欢常规注释！）

您还可以以其他方式做出贡献

• 撰写博客文章
• 在社交媒体上发布有关如何使用Salt+Freezer解决您问题的帖子，包括视频
• 在会议上发表讲话
• 发布视频
• 在IRC、Slack或电子邮件组中提问/回答问题

这些事物对我们的社区来说都非常有价值，我们真诚地感谢每一个贡献！

更多信息，请构建文档并访问 http://localhost:8000/ —— 那里您可以找到其余的文档。