Fix misspellings in Go comments, log messages and error strings

未关闭 适合新手
#7,565 5 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 2 天内回复

@oree-xx 已经在做这个了。

开始于 2026年11月3日。

评估

难度
2/5
预计耗时
半天
新手友好度
85/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
go
领域
backend, tooling

调研方向

从一个区域开始,例如 pkg/app/piped/driftdetector,只修复 issue 中列出的注释、日志和错误字符串中的拼写错误。保留标识符不变,并跳过两处 .proto 注释,因为它们需要运行 make gen/code。对改动过的模块运行 make test/go,并注意 pkg/app/pipedv1/plugin 是一个独立的 Go 模块。当列出的拼写在你负责的区域中已修正且该区域的测试通过时,即视为完成。

由索引模型根据 Issue 内容生成。

描述

area/go good first issue kind/enhancement

What happened:

A spell check over the Go sources, protobuf definitions and test fixtures finds about 110 misspellings in comments, log messages and error strings.

Full list (file:line: wrong ==> right)
cmd/controlplane/ops.go:174: runnning ==> running
pkg/jwt/jwt.go:30: singed ==> signed, singled, sang, sung
pkg/configv1/application.go:473: splited ==> split
pkg/configv1/application.go:474: splited ==> split
pkg/configv1/application_test.go:242: sepcified ==> specified
pkg/configv1/application_test.go:285: sepcified ==> specified
pkg/app/piped/deploysource/deploysource.go:170: unsupport ==> unsupported
pkg/app/piped/apistore/applicationstore/store.go:37: specifiec ==> specific
pkg/app/piped/trigger/deployment.go:38: cound ==> could, count, found
pkg/app/piped/planner/kubernetes/kubernetes.go:134: choise ==> choice, choose
pkg/app/piped/planner/kubernetes/kubernetes_test.go:103: mutilple ==> multiple
pkg/app/piped/logpersister/persister.go:72: concurent ==> concurrent
pkg/app/piped/controller/scheduler.go:448: temination ==> termination
pkg/app/piped/controller/scheduler.go:885: evnet ==> event
pkg/app/piped/platformprovider/kubernetes/kubernetes.go:36: mouting ==> moulting, mounting, mouthing, muting, pouting
pkg/app/piped/platformprovider/kubernetes/loader.go:166: unsupport ==> unsupported
pkg/app/piped/platformprovider/kubernetes/resourcekey.go:212: comparation ==> comparison
pkg/app/piped/platformprovider/kubernetes/resourcekey.go:212: namesapce ==> namespace
pkg/app/piped/platformprovider/kubernetes/resourcekey.go:235: comparation ==> comparison
pkg/app/piped/platformprovider/kubernetes/resourcekey.go:235: namesapce ==> namespace
pkg/app/piped/driftdetector/terraform/detector.go:188: unsupport ==> unsupported
pkg/app/piped/driftdetector/terraform/detector.go:220: configurated ==> configured
pkg/app/piped/driftdetector/ecs/detector.go:401: configurated ==> configured
pkg/app/piped/driftdetector/cloudrun/detector.go:246: unsupport ==> unsupported
pkg/app/piped/driftdetector/cloudrun/detector.go:278: configurated ==> configured
pkg/app/piped/driftdetector/lambda/detector.go:217: followings ==> following
pkg/app/piped/driftdetector/lambda/detector.go:294: unsupport ==> unsupported
pkg/app/piped/driftdetector/lambda/detector.go:326: configurated ==> configured
pkg/app/piped/driftdetector/kubernetes/detector.go:215: splited ==> split
pkg/app/piped/driftdetector/kubernetes/detector.go:216: splited ==> split
pkg/app/piped/driftdetector/kubernetes/detector.go:216: splited ==> split
pkg/app/piped/driftdetector/kubernetes/detector.go:260: unsupport ==> unsupported
pkg/app/piped/driftdetector/kubernetes/detector.go:292: configurated ==> configured
pkg/app/piped/driftdetector/kubernetes/detector.go:431: unsupport ==> unsupported
pkg/app/piped/sourceprocesser/sourceprocesser.go:65: Rebuid ==> Rebuild
pkg/app/piped/sourceprocesser/sourceprocesser_test.go:92: attachement ==> attachment
pkg/app/piped/executor/stopsignal.go:35: excutor ==> executor
pkg/app/piped/executor/scriptrun/scriptrun.go:98: Runnnig ==> Running
pkg/app/piped/executor/scriptrun/scriptrun.go:108: srcipt ==> script
pkg/app/piped/executor/customsync/customsync.go:100: Runnnig ==> Running
pkg/app/piped/executor/customsync/rollback.go:84: Runnnig ==> Running
pkg/app/piped/executor/kubernetes/kubernetes.go:617: Anotate ==> Annotate
pkg/app/piped/executor/kubernetes/kubernetes_test.go:221: temlate ==> template
pkg/app/piped/executor/kubernetes/primary.go:39: trigered ==> triggered
pkg/app/piped/executor/kubernetes/rollback.go:185: Runnnig ==> Running
pkg/app/piped/executor/kubernetes/rollback.go:220: srcipt ==> script
pkg/app/piped/executor/kubernetes/traffic.go:160: unsupport ==> unsupported
pkg/app/piped/executor/kubernetes/traffic_test.go:53: speficied ==> specified
pkg/app/piped/livestatestore/livestatestore.go:81: thats ==> that's
pkg/app/piped/livestatestore/livestatestore.go:83: thats ==> that's
pkg/app/piped/livestatestore/livestatestore.go:85: thats ==> that's
pkg/app/piped/livestatestore/livestatestore.go:87: thats ==> that's
pkg/app/piped/livestatestore/livestatestore.go:89: thats ==> that's
pkg/app/piped/livestatestore/kubernetes/reflector.go:168: Kubernets ==> Kubernetes
pkg/app/pipedv1/apistore/applicationstore/store.go:35: specifiec ==> specific
pkg/app/pipedv1/trigger/deployment.go:38: cound ==> could, count, found
pkg/app/pipedv1/plugin/terraform/config/config.go:58: workpsace ==> workspace
pkg/app/pipedv1/plugin/analysis/config/piped.go:126: unknow ==> unknown
pkg/app/pipedv1/plugin/kubernetes_multicluster/provider/kubernetes.go:37: mouting ==> moulting, mounting, mouthing, muting, pouting
pkg/app/pipedv1/plugin/kubernetes_multicluster/deployment/misc_test.go:94: temlate ==> template
pkg/app/pipedv1/plugin/kubernetes/provider/kubernetes.go:38: mouting ==> moulting, mounting, mouthing, muting, pouting
pkg/app/pipedv1/plugin/kubernetes/deployment/baseline_test.go:231: weired ==> weird
pkg/app/pipedv1/plugin/kubernetes/deployment/baseline_test.go:277: weired ==> weird
pkg/app/pipedv1/plugin/kubernetes/deployment/baseline_test.go:323: weired ==> weird
pkg/app/pipedv1/plugin/kubernetes/deployment/baseline_test.go:402: weired ==> weird
pkg/app/pipedv1/plugin/kubernetes/deployment/baseline_test.go:448: weired ==> weird
pkg/app/pipedv1/plugin/kubernetes/deployment/baseline_test.go:494: weired ==> weird
pkg/app/pipedv1/plugin/kubernetes/deployment/misc_test.go:96: temlate ==> template
pkg/app/pipedv1/plugin/kubernetes/deployment/pipeline.go:48: splitted ==> split
pkg/app/pipedv1/controller/scheduler.go:449: temination ==> termination
pkg/app/pipedv1/controller/scheduler.go:890: evnet ==> event
pkg/app/pipedv1/controller/stopsignal.go:35: excutor ==> executor
pkg/app/pipedv1/sourceprocesser/sourceprocesser.go:65: Rebuid ==> Rebuild
pkg/app/pipedv1/sourceprocesser/sourceprocesser_test.go:92: attachement ==> attachment
pkg/app/server/httpapi/auth_handler.go:65: imcoming ==> incoming
pkg/app/server/service/pipedservice/service.proto:142: releated ==> related
pkg/app/server/grpcapi/web_api.go:1296: porject ==> project
pkg/app/ops/handler/handler_test.go:182: mis ==> miss, mist
pkg/app/ops/mysqlensurer/sqlsensurer.go:22: funtions ==> functions
pkg/app/ops/deploymentchaincontroller/updater.go:133: missng ==> missing
pkg/config/application.go:773: splited ==> split
pkg/config/application.go:774: splited ==> split
pkg/config/application_terraform.go:36: workpsace ==> workspace
pkg/config/application_test.go:294: sepcified ==> specified
pkg/config/application_test.go:337: sepcified ==> specified
pkg/config/config.go:217: plaform ==> platform
pkg/config/piped.go:782: unknow ==> unknown
pkg/config/testdata/application/cloudrun-app-canary.yaml:23: thre ==> three, there, their, the
pkg/config/testdata/application/k8s-app-bluegreen-with-analysis.yaml:3: againts ==> against
pkg/config/testdata/application/k8s-app-canary.yaml:159: comparision ==> comparison
pkg/config/testdata/application/lambda-app-canary.yaml:18: thre ==> three, there, their, the
pkg/plugin/sdk/logpersister/persister.go:75: concurent ==> concurrent
pkg/plugin/sdk/diff/diff.go:238: unsupport ==> unsupported
pkg/plugin/sdk/diff/diff.go:245: seccond ==> second
pkg/diff/diff.go:112: calulates ==> calculates
pkg/diff/diff.go:303: unsupport ==> unsupported
pkg/diff/diff.go:310: seccond ==> second
pkg/model/application.proto:64: trigered ==> triggered
pkg/model/common_test.go:59: kuberntes ==> kubernetes
pkg/model/project.go:544: nott ==> not
pkg/model/project_test.go:510: doen't ==> doesn't
pkg/model/stage.go:53: splitted ==> split
pkg/model/stage.go:92: splitted ==> split
pkg/rpc/rpcauth/interceptor.go:205: unsufficient ==> insufficient
tool/codegen/protoc-gen-auth/main.go:100: pasing ==> parsing, passing, posing
tool/actions-plan-preview/main.go:122: conficts ==> conflicts, convicts
tool/actions-plan-preview/planpreview_test.go:599: chages ==> changes, charges

What you expected to happen:

Comments, log messages and error strings are spelled correctly.

How to fix:

  • Fix text only: comments, log messages, error strings and test names. Do not rename identifiers (variables, functions, struct fields, JSON tags), since that changes behaviour or the public API.
  • Two hits are in .proto comments (pkg/model/application.proto, pkg/app/server/service/pipedservice/service.proto). Changing them requires running make gen/code and committing the regenerated files, so it is fine to leave them for a separate PR.
  • Please split the work into a few small PRs, for example one per top-level area (pkg/app/piped, pkg/app/pipedv1, pkg/config + pkg/configv1, everything else). Small PRs get reviewed faster.
  • Run make test/go on the touched modules. Plugin modules under pkg/app/pipedv1/plugin/ are separate Go modules, see the Testing section of CONTRIBUTING.md.
  • The list was produced with codespell (https://github.com/codespell-project/codespell). Known false positives already removed: listIn, commitish, numer, upToDate, als, unparseable.

Environment:

  • Checked against master at b2c679c6f (1 Nov 2026).
主要语言
Go
星标
1.4k
派生
391
平均合并
4 天 1 小时
30 天内合并 PR
58

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

pipe-cd/pipecd 的其他 Issue

查看 pipe-cd/pipecd 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。