https://acmestack.com/zh/docs/contributing/Recent content in 贡献 onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:49:15 +0000https://acmestack.com/zh/docs/contributing/guide/Tue, 06 Oct 2020 08:49:31 +0000https://acmestack.com/zh/docs/contributing/guide/本指南适用于已经提交Pull Request的贡献者。 首次贡献者应从贡献者指南开始，贡献者指南也适用于所有开发者。 让我们从开发者环境设置开始https://acmestack.com/zh/docs/contributing/developer-environment-setting/Thu, 12 Nov 2020 13:26:54 +0100https://acmestack.com/zh/docs/contributing/developer-environment-setting/goland的示例 版权 # 带格式复制如下内容 Licensed to the AcmeStack under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.https://acmestack.com/zh/docs/contributing/contributor-license-agreement/Thu, 12 Nov 2020 13:26:54 +0100https://acmestack.com/zh/docs/contributing/contributor-license-agreement/如何签署 # 在创建你的第一个Pull Request之后，CLA（贡献者许可协议 Contributor License Agreement） 助手机器人将响应有关您的 CLA 状态信息以及用于签署 CLA 的链接。 确保 git config user.name 与 GitHub 的用户名相同。 回复 I have read the CLA Document and I hereby sign the CLA 来签署 CLA. 并回复 recheck 以检查签名状态。https://acmestack.com/zh/docs/contributing/github-workflow-guide/Thu, 12 Nov 2020 13:26:54 +0100https://acmestack.com/zh/docs/contributing/github-workflow-guide/1. 从云端 Fork # 打开 https://github.com/acmestack 选中一个项目 单击 Fork 按钮 (右上角) 建立一个基于云端的fork. 2. Clone fork 到本地 # 根据 Go语言的 工作区说明, 根据以下命令将克隆下来的项目代码放在您的 GOPATH 上。 git clone git@github.com:<your_name>/{project-name}.git 3. 设置远程仓库以同步更新 # git remote add upstream https://github.com/acmestack/{project-name}.git 保持分支同步 # 您将需要定期从upstream仓库中获取变更来保持您的工作分支同步。请注意，根据您使用的仓库，默认分支可能叫做“main”而不是“master”。 确保您的本地仓库位于您的工作分支上并运行以下命令以使其保持同步： git fetch upstream git rebase upstream/master 请不要使用 git pull 而不是以上的 fetch 和 rebase. 由于 git pull 执行合并，它会创建合并提交。这些使提交历史变得混乱，违反了提交应该是人们易于理解和有用的原则（见下文）。 您也可以考虑通过 git config branch.autoSetupRebase always 更改您的.git/config 文件，以更改 git pull 的行为，或其他非合并选项，例如 git pull --rebasehttps://acmestack.com/zh/docs/contributing/coding-conventions/Thu, 12 Nov 2020 13:26:54 +0100https://acmestack.com/zh/docs/contributing/coding-conventions/Go Go Code Review Comments Effective Go 了解和避免 Go landmines 代码注释 Go’s commenting conventions 如果审查者询问这段代码为什么是这样，那么注释会非常有用。 命令行标志应该使用破折号，而不是下划线 命名 选择接口名称时请考虑包名，避免冗余。 例如, storage.Interface 优于 storage.StorageInterface。 不要在包名称中使用大写字符、下划线或破折号。 选择包名时请考虑父目录名。 例如, pkg/controllers/autoscaler/foo.go 应该叫 package autoscaler 而不是 package autoscalercontroller。 除非有充分的理由, package foo 行应该与 .go 文件所在目录的名称相匹配。 如果需要消除歧义，引入者可以使用不同的名称。 锁应该被称为 lock 并且永远不应该被嵌入 (always lock sync.Mutex). 当存在多个锁时，按照 Go 约定为每个锁指定一个不同的名称： stateLock, mapLock 等。 [API conventions] [Logging conventions] Go语言代码注释模板 # 普通方法注释 # 模板 // ${function_name} // @receiver ${receiver} // @param ${params} // @return ${return_types} 示例 // Identity figure the configuration's identity.https://acmestack.com/zh/docs/contributing/pull-requests/Tue, 06 Oct 2020 08:49:31 +0000https://acmestack.com/zh/docs/contributing/pull-requests/在您提交 Pull Request之前 # 本指南适用于已经提交Pull Request的贡献者。 首次贡献者应前往贡献者指南 开始，贡献者指南也适用于所有开发者。 确保您的pull request符合我们的最佳实践。 其中包括以下项目规范， 提出小的pull requests, 并且有足够的注释. 详情参阅文档末尾 Best Practices for Faster Reviews 。 本地运行并且验证 # 您可以在提交pull request之前运行这些本地验证，以预测持续集成的通过或失败。 Pull Request提交流程 # 合并pull request需要在pull request自动合并之前完成以下步骤。 创建一个pull request 对于首次贡献者签署 Contributor License Agreement 通过所有 e2e 测试 获得审查者和代码所有者的所有必要批准 ##标记未完成的 Pull Requests 如果您想在Pull Requests完成之前征求审查，您应该保留您的pull request，以确保 Tide 不会标记并尝试合并它。 有两种方法可以实现这一点： 您可以添加 /hold 或 /hold cancel 注释 您可以在您的pull request添加或移除 WIP 或 [WIP] 前缀 我们将在您使用do-not-merge/hold注释处添加或删除标签并在 do-not-merge/work-in-progress 您编辑标题时添加和删除标签。 当任一标签存在时，您的pull request将不会被考虑合并。https://acmestack.com/zh/docs/contributing/testing-guide/Tue, 06 Oct 2020 08:49:31 +0000https://acmestack.com/zh/docs/contributing/testing-guide/TODO