Skip to content

Commit 1e3f705

Browse files
committed
Resolve comments
Signed-off-by: Jian Qiu <jqiu@redhat.com>
1 parent 1623d84 commit 1e3f705

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

development.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Open Cluster Management (OCM) is a CNCF sandbox project that provides multiclust
2626

2727
### Key Technologies
2828

29-
- **Language**: Go 1.24+
29+
- **Language**: Go 1.24.0
3030
- **Framework**: Kubernetes operators with controller-runtime
3131
- **Build System**: Make with OpenShift build machinery
3232
- **Testing**: Ginkgo/Gomega for BDD-style tests
@@ -51,7 +51,7 @@ Open Cluster Management (OCM) is a CNCF sandbox project that provides multiclust
5151

5252
2. **Initialize OCM control plane**:
5353
```bash
54-
curl -sL https://raw.githubusercontent.com/open-cluster-management/clusteradm/main/hack/install.sh | bash
54+
curl -fsSL https://raw.githubusercontent.com/open-cluster-management-io/clusteradm/main/hack/install.sh | bash
5555
clusteradm init --wait --bundle-version="latest"
5656
```
5757

@@ -154,7 +154,6 @@ kubectl edit klusterlet klusterlet # For spoke components
154154

155155
- **Follow standard Go conventions**: Use `gofmt`, `go vet`, and `golangci-lint`
156156
- **Variable naming**: Use camelCase for local variables, PascalCase for exported items
157-
- **Error handling**: Always handle errors explicitly, use `errors.Wrap()` for context
158157
- **Comments**: Write clear comments for exported functions and complex logic
159158
- **Interface design**: Keep interfaces small and focused (interface segregation principle)
160159

@@ -202,7 +201,7 @@ make fmt-imports # Automatically format import statements
202201

203202
- **Files**: Use snake_case (e.g., `cluster_controller.go`)
204203
- **Packages**: Use lowercase, single words when possible
205-
- **Constants**: Use ALL_CAPS with underscores
204+
- **Constants**: Use CamelCase (PascalCase for exported constants); reserve ALL_CAPS only when mirroring external specs
206205
- **Controllers**: Suffix with `Controller` (e.g., `PlacementController`)
207206
- **Interfaces**: Use descriptive names, often ending with `-er` (e.g., `ClusterLister`)
208207

@@ -240,8 +239,8 @@ End-to-end tests run against real clusters and require a kind cluster with prope
240239

241240
```bash
242241
# 1. Create kind cluster and set KUBECONFIG
243-
kind create cluster --name ocm-e2e
244-
export KUBECONFIG=$(kind get kubeconfig-path --name ocm-e2e)
242+
kind get kubeconfig --name ocm-e2e > /tmp/kubeconfig-ocm-e2e
243+
export KUBECONFIG=/tmp/kubeconfig-ocm-e2e
245244

246245
# 2. Run E2E tests with required variables
247246
IMAGE_TAG=e2e KLUSTERLET_DEPLOY_MODE=Singleton make test-e2e

0 commit comments

Comments
 (0)