From 70ecec9c7a9c19964c8e476249966fe52a40e6b2 Mon Sep 17 00:00:00 2001 From: Miciah Dashiel Butler Masters Date: Mon, 12 Jan 2026 14:39:48 -0500 Subject: [PATCH 1/2] HACKING.md: Fix a typo: "dockerifle" * HACKING.md: Replace "dockerifle" with "Dockerfile". --- HACKING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/HACKING.md b/HACKING.md index 758d0ba58..7b6a06aeb 100644 --- a/HACKING.md +++ b/HACKING.md @@ -24,7 +24,7 @@ $ make To test Router changes on an available cluster, utilize `Dockerfile.debug` and `Makefile.debug` in `hack/`. -`Dockerfile.debug` is a multi-stage dockerifle for building the Router binary, +`Dockerfile.debug` is a multi-stage Dockerfile for building the Router binary, as well as the Router image itself. The outputted image uses `centos:8` as it's base since installing packages on an OpenShift RHEL base image requires RHEL entitlements. From 9aef0d07cd1588b12264d018ef70808afccfeb12 Mon Sep 17 00:00:00 2001 From: Miciah Dashiel Butler Masters Date: Mon, 12 Jan 2026 14:40:51 -0500 Subject: [PATCH 2/2] Add AGENTS.md * AGENTS.md: New file. * CLAUDE.md: New file. Symlink to AGENTS.md. --- AGENTS.md | 29 +++++++++++++++++++++++++++++ CLAUDE.md | 1 + 2 files changed, 30 insertions(+) create mode 100644 AGENTS.md create mode 120000 CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 000000000..671027e79 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,29 @@ +# Shell commands + +- `make`, `make all`, or `make build`: Build the `openshift-router` executable. +- `make check`: Run unit tests for `openshift-router`. +- `make verify`: Verify that source code is properly formatted and that Go mod dependencies are correct. + +Note that there is no make target for generated files. Also, this repository +does not have any integration or end-to-end tests; see the [openshift/origin](https://github.com/openshift/origin/tree/master/test/extended/router/) +or [openshift/cluster-ingress-operator](https://github.com/openshift/cluster-ingress-operator/tree/master/test/e2e/) repositories for those. + +See also [the `HACKING.md` file](./HACKING.md) in this repository for some more advanced +commands for building and testing images. + +# Code style + +- Format code using gofmt. +- Add godoc for all package-level identifiers. Use your discretion, but when in doubt, add godoc. +- Write unit tests for new functionality. Use the standard Go testing package; we don't use Ginkgo or other testing frameworks in this repository. +- Add code comments as appropriate, using complete English sentences. Be kind to your fellow developers, including future you. +- In the absence of OpenShift-specific conventions, refer to the [Kubernetes Coding Conventions](https://www.kubernetes.dev/docs/guide/coding-convention/). Use your discretion; when in doubt, ask. + +# Workflow + +- Use commits to group changes logically. For example, sometimes it makes sense to do some refactoring in one commit, and then implement your defect fix or feature in a separate commit. +- Ensure each commit passes `make verify check`. +- Follow the [OpenShift](https://github.com/openshift/enhancements/blob/master/guidelines/commit_and_pr_text.md) and [Kubernetes commit message guidelines](https://www.kubernetes.dev/docs/guide/pull-requests/#commit-message-guidelines). +- If your code change requires `go mod` updates, commit the `go mod` updates (including `vendor/`) and document them in your commit message. Put your code changes and `go mod` updates in the same commit so that they can be reviewed and tested (using `make verify`) as a unit. +- Rebase in case of merge conflicts. Please don't have merge commits in your pull request. +- Please be sure to respond to PR review comments. If you accept a suggestion, say so. If you need clarification, ask. If you reject a suggestion, explain why; don't be shy, but do be respectful and forthright. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 000000000..47dc3e3d8 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file