From 70b8e556991031bf4907312c5a88690dfafb56ad Mon Sep 17 00:00:00 2001 From: Sam Berning <113054166+sam-berning@users.noreply.github.com> Date: Thu, 5 Jan 2023 12:50:57 -0600 Subject: [PATCH] docs: Recommends ginkgo focus decorator for e2e tests (#137) Signed-off-by: Sam Berning Issue #, if available: N/A *Description of changes:* Adds documentation to recommend use of ginkgo's Focus decorator while developing e2e tests *Testing done:* N/A - [x] I've reviewed the guidance in CONTRIBUTING.md #### License Acceptance By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. Signed-off-by: Sam Berning --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a2e876f8a..98b944455 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -224,6 +224,8 @@ implement them in common-tests repo and then import them in [`./e2e/e2e_test.go` Otherwise, it means that the scenarios are specific to finch CLI (e.g., version, VM lifecycle, etc.), and you should implement them under `./e2e/` (e.g., `./e2e/version.go`) and import them in `./e2e/e2e_test.go`. +To save time while developing e2e tests, use the [`Focus`](https://onsi.github.io/ginkgo/#focused-specs) decorator while running tests, but be sure to remove it before PR-ing your changes. + ### Go File Naming Keep file names to one word if possible (e.g., avoid stuttering with package name: prefer `thing/factory.go` over `thing/thing_factory.go`). If there have to be more than one words, use underscores as separators. Do not use hyphens or camelCase.