diff --git a/docs/bugs.md b/docs/bugs.md index 5cb92b9a5..a422d02a5 100644 --- a/docs/bugs.md +++ b/docs/bugs.md @@ -4,27 +4,24 @@ [reusable custom transformer test]: /api/krusty/customconfigreusable_test.go File issues as desired, but if you've found a problem -with how `kustomize build` works, consider the -following to improve response time. - -## A good report specifies +with how `kustomize build` works, please report * the output of `kustomize version`, * the input (the content of `kustomization.yaml` and any files it refers to), * the expected YAML output. -## A great report is a bug reproduction test +## If you have `go` installed kustomize has a simple test harness in the [krusty package] for specifying a kustomization's input and the expected output. Copy one of those tests, e.g. this [reusable custom -transformer test], to a new test file (with a new -`foo_test.go` name). +transformer test], to a new test file in the +krusty package. -Insert the inputs you want to use, and run it like +Insert the inputs you want to use, and run it as you'd run the reusable custom transformer test: ```