Salt GitHub扩展

与GitHub交互的Salt扩展

安全

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

用户文档

此README是为希望为项目做出贡献的人编写的。如果您只想开始使用扩展，请参阅用户文档。

贡献

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

有关更多信息，请参阅Salt贡献指南，但如果您想立即开始，以下是开始步骤：

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

# Change to the repo dir
cd saltext-github

# Create a new venv
python3 -m venv env --prompt saltext-github
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 + GitHub解决问题的内容，包括视频
• 在会议上发表演讲
• 发布视频
• 在IRC、Discord或电子邮件组中提问/回答问题

这些对我们的社区来说都非常有价值，我们衷心感谢每个贡献！

有关更多信息，请构建文档并访问http://localhost:8000/ —— 您将在那里找到其他文档。