etcd-io/etcd
How to contribute
This section translates CONTRIBUTING.md and the project's day-to-day practices into wiki form. For the canonical, ground-truth document, always read CONTRIBUTING.md at the repo root.
What lives in this section
- Development workflow — branch, code, test, PR, merge.
- Testing — unit, integration, e2e, robustness, fuzzing.
- Debugging — flakes, log inspection, dump tools, stress.
- Patterns and conventions — error handling, logging, package boundaries.
- Tooling — Make targets, scripts, lint config, code generation.
Definition of done
A change typically lands when:
make verifyis clean (verify-bom,verify-lint,verify-mod-tidy,verify-shellcheck,verify-shellws,verify-proto-annotations,verify-genproto,verify-yamllint,verify-markdown-marker,verify-go-versions,verify-gomodguard,verify-go-workspace,verify-grpc-experimental).make test-unitpasses locally; integration / e2e / robustness tests cover any new functional surface.- The PR follows etcd's commit-message convention:
<package>: <imperative summary>with aSigned-off-by:(DCO) trailer. - A reviewer with approver rights (see
OWNERSandOWNERS_ALIASES) gives/approveand/lgtm.
How review works
etcd uses Kubernetes Prow for pull-request automation, plus GitHub Actions for a smaller subset of jobs (.github/workflows/). Test results aggregate at https://testgrid.k8s.io/sig-etcd. PRs get auto-labelled with do-not-merge/work-in-progress for drafts, needs-ok-to-test for first-time contributors, and lgtm once a reviewer signs off.
Where to ask questions
- Slack:
#sig-etcdon Kubernetes Slack. - Mailing list:
etcd-dev@googlegroups.com. - Weekly community meetings (alternating with issue triage), Thursdays 11 AM Pacific.
- See
README.mdfor joining details.
Built by Factory AutoWiki from public repository content. It is a generated preview for codebase exploration, not source-maintained documentation.