Microsoft Security Copilot 社区

欢迎来到 Security Copilot 仓库！

Microsoft Security Copilot 是一款基于生成式 AI 的助手，用于安全和 IT 领域的日常运营，能够帮助团队以 AI 的速度和规模进行防护。

• https://learn.microsoft.com/en-us/security-copilot/
• https://learn.microsoft.com/en-us/security-copilot/get-started-security-copilot
• https://learn.microsoft.com/en-us/security-copilot/plugin_overview
• https://learn.microsoft.com/en-us/security-copilot/connectors-overview
• https://aka.ms/copilotforsecurity

贡献说明

本项目欢迎各位贡献者提交代码和建议。大多数贡献都需要您签署贡献者许可协议（CLA），声明您有权且确实将您的贡献使用权授予我们。详情请访问：https://cla.opensource.microsoft.com。

当您提交拉取请求时，CLA 机器人会自动判断您是否需要提供 CLA，并相应地标记您的 PR（例如通过状态检查或评论）。您只需按照机器人提供的指示操作即可。对于使用我们 CLA 的所有仓库，您只需完成一次此流程。

本项目已采纳 Microsoft 开源行为准则。更多信息请参阅 行为准则常见问题解答 或发送邮件至 opencode@microsoft.com 咨询更多问题或意见。

以下是开始为本项目做出贡献的步骤：

GitHub 账号：

• 注册一个 GitHub 账号 – (www.github.com ) - 免费账号即可。
• 使用新账号登录。

复刻仓库：

• 访问社区页面：https://github.com/Azure/Copilot-For-Security
• 确保您位于主分支上。
• 点击“Fork” -> “Create a new fork”
• 这将在您的 GitHub 账号中创建 Security Copilot 仓库的副本：

将 Fork 克隆到本地机器：

• 如果您尚未安装 Git，可从 https://git-scm.com/downloads 下载并安装 GitBash。

• 在您的本地机器上创建一个目录，用于存放克隆下来的仓库以及后续的工作内容。示例：“C:\Users(username)\Documents\GitForks”。

• 打开 GitBash，进入该目录：“C:\Users(username)\Documents\GitForks”。

• 运行：Git init

• 运行：Git clone <您的 Fork 地址> 例如：Git clone “https://github.com/(username)/ Copilot-For-Security-Fork”

• 切换到新创建的目录，即 cd Copilot-For-Security-Fork。

• 设置上游远程仓库，即您所 fork 的原始仓库——Copilot-For-Security 社区仓库。

• 运行：Git remote add upstream https://github.com/Azure/Copilot-For-Security

• 运行：Git remote -v

  ![克隆到本地目录](https://oss.gittoolsai.com/images/Azure_Security-Copilot_readme_f6515fc6a071.png)
  

您也可以通过下载 GitHub Desktop 来完成此操作，网址为：https://desktop.github.com。

创建分支：

• 您可以直接在本地主分支上工作，但建议使用分支，这样如果您同时处理多个项目，可以保持它们彼此隔离。
• 首先，您需要将本地仓库与上游主分支同步（即 Azure 社区本身——不是您的 Fork）。 运行：git pull upstream main
• 您应该会看到更新列表，或者提示您已是最新版本。
• 同步完成后，创建您的新分支。 运行：Git checkout -b <分支名称> 例如 Git checkout -b Sojeshs_CFSContributions

安装 VS Code：

[下载 Visual Studio Code - Mac、Linux、Windows]

在 VS Code 中打开分支：

• 打开 VS Code，然后选择“文件”>“打开文件夹”，选择本地仓库目录（示例：C:\Users\(username)\Documents\GitForks\Copilot-For-Security-Fork）。
• 您应能看到仓库中的所有目录和文件，在底部显示当前正在工作的分支。请确保在进行任何更改前选择了正确的分支。

暂存、提交并推送您的更改：

• 当您在 VS Code 中完成所需内容的编辑后，需要先暂存并提交这些更改。这会将更改提交到您本地机器上创建的分支。例如，我在“Community Based Plugins”目录下创建了一个名为“SentinelDailyOperations”的新文件夹，并添加了一个名为“KQL_SentinelDailyOperationsSample.yml”的 KQL 插件。您还可以添加其他必要的内容来记录和部署此插件。

• 当您准备好提交更改时，点击左侧的“源代码管理”图标，输入一条总结您更改的留言，然后点击“+”。这将暂存您的更改。接下来，点击对勾标记以提交更改。此时这些更改仍仅存在于您的本地机器上。

• 现在您可以将这些更改发布到您个人的 GitHub 上，只需点击分支名称旁边的图标（如果顶部弹出仓库列表，请选择您的仓库 /Copilot-For-Security 而非 Azure/Copilot-For-Security）。在本示例中，我们选择主分支来发布包含新插件的更改。

• 您现在可以在 GitHub 中查看您提交的更改，进入相应的分支：

• 如果您已完成所有工作并准备提交到主仓库，则需要发起一个拉取请求。该请求将触发一系列自动化检查，若检查通过，则会提交给评审委员会——其中一位评审员将审核您的工作并接受请求，最终将其合并到主分支。

“打开拉取请求”页面的顶部非常重要。这里会显示你正在从哪个仓库和分支拉取代码，以及要合并到哪个仓库中。你应该在评论区填写一个有意义的标题，并列出你所做的更改，因为评审者会阅读这部分内容。然后点击“创建拉取请求”。

一旦更改被合并到主 GitHub 仓库，你应该能够看到这些更改已提交到主 GitHub 仓库中。

检查你的拉取请求状态并从主仓库同步

在你的拉取请求被合并后，请务必确认它已成功进入主仓库。我们建议你同时在 GitHub 网站上进行检查，并在本地仓库执行同步操作，以验证更改是否已正确应用。

祝你好运，并欢迎为 Security Copilot 社区做出贡献！！！！

Security Copilot 社区贡献快速上手指南

Microsoft Security Copilot 是一款由生成式 AI 驱动的安全助手。本指南旨在帮助开发者快速搭建环境，向 Security Copilot 社区仓库贡献插件、连接器或文档。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Windows, macOS 或 Linux。
• GitHub 账号：需拥有有效的 GitHub 账号（免费注册即可）。
• Git 工具：已安装 Git 命令行工具。
  • Windows 用户推荐安装 Git Bash。
  • 国内加速建议：若下载缓慢，可尝试使用国内镜像源或代理加速。
• 代码编辑器：推荐安装 Visual Studio Code (VS Code)。
  • 国内加速建议：国内用户可通过 清华大学开源软件镜像站 下载 VS Code。

安装与配置步骤

1. Fork 仓库

首先将官方仓库复制到您个人的 GitHub 账号下：

1. 访问社区页面：https://github.com/Azure/Copilot-For-Security
2. 确保当前位于 main 分支。
3. 点击右上角的 Fork 按钮，选择 Create a new fork。
4. 完成后，您将拥有一个名为 <您的用户名>/Copilot-For-Security 的副本。

2. 克隆仓库到本地

打开终端（Git Bash），执行以下命令将代码拉取到本地：

# 创建本地工作目录（示例路径）
mkdir -p ~/Documents/GitForks
cd ~/Documents/GitForks

# 克隆您的 Fork 仓库（请替换 <username> 为您的 GitHub 用户名）
git clone https://github.com/<username>/Copilot-For-Security.git

# 进入项目目录
cd Copilot-For-Security

# 添加上游远程仓库（指向原始 Azure 仓库）
git remote add upstream https://github.com/Azure/Copilot-For-Security

# 验证远程仓库配置
git remote -v

3. 创建开发分支

为了隔离开发工作，建议基于最新的 main 分支创建新分支：

# 同步上游仓库的最新代码
git pull upstream main

# 创建并切换到新分支（请替换 <branch-name> 为有意义的分支名）
git checkout -b <branch-name>
# 示例：git checkout -b my_kql_plugin_contrib

4. 开发与提交

1. 使用 VS Code 打开本地项目文件夹：

   code .
   

2. 在 VS Code 左下角确认当前选中的是您创建的分支。
3. 编写您的贡献内容（例如在 Community Based Plugins 目录下添加新的 YAML 插件文件）。
4. 暂存并提交更改：

   # 暂存所有更改
   git add .
   
   # 提交更改（请填写清晰的提交信息）
   git commit -m "Add new KQL plugin for Sentinel daily operations"
   

5. 推送至 GitHub

将本地分支推送到您的个人 GitHub 仓库：

# 推送分支（首次推送需设置上游）
git push --set-upstream origin <branch-name>

基本使用：提交贡献 (Pull Request)

完成代码推送后，您需要发起合并请求（Pull Request）以便社区审核：

1. 访问您的 GitHub 仓库页面（https://github.com/<username>/Copilot-For-Security）。
2. 点击 Compare & pull request 按钮。
3. 关键检查：
   • base repository: Azure/Copilot-For-Security
   • base branch: main
   • head repository: <您的用户名>/Copilot-For-Security
   • compare branch: 您刚才推送的分支名
4. 填写标题和详细描述，说明您的贡献内容（例如新增了什么插件或修复了什么问题）。
5. 点击 Create pull request。

系统会自动运行检查流程。检查通过后，维护人员将审核您的代码。一旦合并成功，您的贡献将出现在主仓库中。

提示：合并后，建议在本地执行 git pull upstream main 同步最新代码，以确保本地环境与社区保持一致。