From 9579a751ab181c9edd8c5d78cf47e98db96ef876 Mon Sep 17 00:00:00 2001 From: Bertocq Date: Wed, 7 Feb 2018 02:03:17 +0100 Subject: [PATCH] Improve flaky issue template --- .github/ISSUE_TEMPLATE/flakies.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/flakies.md b/.github/ISSUE_TEMPLATE/flakies.md index e30a0ca84..d7fde88a5 100644 --- a/.github/ISSUE_TEMPLATE/flakies.md +++ b/.github/ISSUE_TEMPLATE/flakies.md @@ -43,3 +43,10 @@ After executing rspec you can see the seed used, add it as an option to rspec, f ### Other things to watch for - Time related issues (current time, two time or date comparisons with miliseconds/time when its not needed) - https://semaphoreci.com/community/tutorials/how-to-deal-with-and-eliminate-flaky-tests + +### Final thoughts +The true objective of this issue is not "to fix" a flaky spec, but to change a spec that randomly fails into one that we can trust when it passes (or fails). + +That means you've to think "What are we testing here?" and "Can we test the same thing in another way?" or "Are we already testing this somewhere else at least partially?". + +Sometimes the fix is to re-write the entire tests with a different approach, or to extend an existing spec. Tests are sometimes written without taking a look at other tests files neither near scenarios.