diff --git a/CONTRIBUTING_zh.md b/CONTRIBUTING_zh.md new file mode 100644 index 0000000000..7aef2f5dcb --- /dev/null +++ b/CONTRIBUTING_zh.md @@ -0,0 +1,33 @@ +# 贡献准则 + +Vcpkg 是一个尝试由社区驱动,旨在构建一个多产的、健壮的本地库生态系统 - 您的贡献价值不可估量! + +## 报告问题 + +最简单的方法是通过 `vcpkg.exe` 或 [GitHub](https://github.com/Microsoft/vcpkg) 报告已有的包的问题。 当报告 `vcpkg.exe` 的问题时,确保清楚地说明: +- 机器设置: “我用的是Windows 10周年更新。 我的机器正位于fr-fr区域。 我成功地运行了'install boost'。” +- 复现步骤: “运行 'vcpkg list'” +- 预期结果: “我预期看到 'boost:x86-windows'” +- 实际结果: “没有输出” 或 “我得到一个崩溃对话框” + +当报告包的问题时,一定要清楚地说明: +- 机器设置 (上述) +- 您正在构建什么包以及它的版本,例如: “opencv 3.1.0” +- 构建过程中的任何相关错误日志 + +## 贡献 (PR) + +我们很乐意接受关于修复、特性、新包和更新现有包的拉取请求。 为了避免浪费您的时间,我们强烈建议您提交一个问题来讨论您想要制作的PR是否能被接受。 对于特性和新包来说也是如此。 + +### 新包贡献准则 + +我们很高兴您有兴趣来提交一个新的包! 这里有一些指导方针来帮助您编写一个优秀的端口文件: +- 避免功能补丁。 当没有其他方法时,补丁应该被视为实现兼容性的最后手段。 +- 当无法避免补丁时,请不要修改默认行为。 一个补丁的理想生命周期是与上游合并,不再被需要。 在决定如何修补某些内容时,请记住这一目标。 +- 相比原始的 `execute_command` 调用,尽量改为通过 `vcpkg_xyz` 函数实现。这使得在添加新特性(如自定义编译器标志或生成器)时更容易进行长期维护。 + +## 法律声明 + +在您的拉取请求被接受之前,您需要完成一个贡献者许可协议 (CLA)。 本协议证明您允许我们使用您提交的源代码,并且本作品是在合适的许可下提交的,我们可以使用它。 + +您可以通过 https://cla.microsoft.com 上的步骤来完成CLA。 一旦我们收到已签署的CLA,我们将审查请求。 您只需要这样做一次。 diff --git a/README_zh_CN.md b/README_zh_CN.md index 642b81fe66..5c4ddc5786 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -5,7 +5,7 @@ Vcpkg 可帮助您在 Windows、 Linux 和 MacOS 上管理 C 和 C++ 库。 这个工具和生态链正在不断发展,我们一直期待您的贡献! -若您从未使用过vcpkg或希望了解如何使用vcpkg,请查阅[快速开始](#入门)章节。 +若您从未使用过vcpkg,或者您正在尝试了解如何使用vcpkg,请查阅 [入门](#入门) 章节。 如需获取有关可用命令的简短描述,请在编译vcpkg后执行 `vcpkg help` 或执行 `vcpkg help [command]` 来获取具体的帮助信息。 @@ -32,13 +32,13 @@ Vcpkg 可帮助您在 Windows、 Linux 和 MacOS 上管理 C 和 C++ 库。 - [将 vcpkg 作为一个子模块](#将-vcpkg-作为一个子模块) - [Tab补全/自动补全](#tab补全自动补全) - [示例](#示例) - - [贡献者](#贡献者) -- [License](#license) + - [贡献](#贡献) +- [开源协议](#开源协议) - [数据收集](#数据收集) # 入门 -首先,请阅读以下任一方面的快速入门指南: +首先,请阅读以下任一快速入门指南: [Windows](#快速开始-windows) 或 [macOS和Linux](#快速开始-unix), 这取决于您使用的是什么平台。 @@ -57,7 +57,7 @@ vcpkg团队和贡献者可以看到它的地方, ## 快速开始: Windows -需求: +前置条件: - Windows 7 或更新的版本 - [Git][getting-started:git] - [Visual Studio 2015 Update 3][getting-started:visual-studio] 或更新的版本(**包含英文语言包**) @@ -95,14 +95,14 @@ vcpkg团队和贡献者可以看到它的地方, > .\vcpkg\vcpkg search [search term] ``` -若您希望在 Visual Studio 中使用vcpkg,请运行以下命令 (首次启动需要管理员权限) +若您希望在 Visual Studio 中使用vcpkg,请运行以下命令 (可能需要管理员权限) ```cmd > .\vcpkg\vcpkg integrate install ``` 在此之后,您可以创建一个非cmake项目 (或打开已有的项目)。 -在您的项目中,所有已安装的库均可立即使用 `#include` 包含您需使用的库的头文件且无需添加额外配置。 +在您的项目中,所有已安装的库均可立即使用 `#include` 包含您需使用的库的头文件且无需额外配置。 若您在 Visual Studio 中使用cmake工程,请查阅[这里](#visual-studio-cmake-工程中使用-vcpkg)。 @@ -120,11 +120,11 @@ vcpkg团队和贡献者可以看到它的地方, ## 快速开始: Unix -Linux平台的使用需求: +Linux平台前置条件: - [Git][getting-started:git] - [g++][getting-started:linux-gcc] >= 6 -macOS平台的使用需求: +macOS平台前置条件: - [Apple Developer Tools][getting-started:macos-dev-tools] 首先,**请使用git clone vcpkg** 并执行 bootstrap.sh 脚本。 @@ -284,7 +284,7 @@ $ ./vcpkg integrate bash # 或 zsh 观看4分钟 [demo视频](https://www.youtube.com/watch?v=y41WFKbQFTw)。 -## 贡献者 +## 贡献 Vcpkg是一个开源项目,并通过您的贡献不断发展。 下面是一些您可以贡献的方式: @@ -292,7 +292,7 @@ Vcpkg是一个开源项目,并通过您的贡献不断发展。 * [提交一个关于vcpkg或已支持包的新issue][contributing:submit-issue] * [提交修复PR和创建新包][contributing:submit-pr] -请参阅我们的 [贡献准则](CONTRIBUTING.md) 了解更多详细信息。 +请参阅我们的 [贡献准则](CONTRIBUTING_zh.md) 了解更多详细信息。 该项目采用了 [Microsoft开源行为准则][contributing:coc]。 获取更多信息请查看 [行为准则FAQ][contributing:coc-faq] 或联系 [opencode@microsoft.com](mailto:opencode@microsoft.com) 提出其他问题或意见。 @@ -302,7 +302,7 @@ Vcpkg是一个开源项目,并通过您的贡献不断发展。 [contributing:coc]: https://opensource.microsoft.com/codeofconduct/ [contributing:coc-faq]: https://opensource.microsoft.com/codeofconduct/ -# License +# 开源协议 在此存储库中使用的代码均遵循 [MIT License](LICENSE.txt)。