consul/grecia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Apply MDL spacing rules in github templates

Browse Source
This commit is contained in:
Javi Martín
2024-06-17 19:10:53 +02:00
parent 55e060424c
commit b2d9d37070
2 changed files with 13 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
.github/ISSUE_TEMPLATE.md vendored
View File

@@ -2,29 +2,27 @@
[comment]: # (As a <user type>, I want to <task> so that <goal>.) [comment]: # (As a <user type>, I want to <task> so that <goal>.)
### Why is this Needed? ### Why is this Needed?
[comment]: # (Describe the problem and why this task is needed. Provide a description of the current state, what you would like to happen, and what actually happened) [comment]: # (Describe the problem and why this task is needed. Provide a description of the current state, what you would like to happen, and what actually happened)
### Description ### Description
[comment]: # (Feature or Bug? eg. Type: Bug) [comment]: # (Feature or Bug? eg. Type: Bug)
*Type*: *Type*:
### Current Behavior ### Current Behavior
[comment]: # (Describe what actually happened.) [comment]: # (Describe what actually happened.)
### Expected Behavior ### Expected Behavior
[comment]: # (Describe what you expected to happen.) [comment]: # (Describe what you expected to happen.)
### Steps to reproduce ### Steps to reproduce
[comment]: # (Describe how we can replicate the bug step by step.) [comment]: # (Describe how we can replicate the bug step by step.)
### Definition of Done ### Definition of Done
[comment]: # (Any other information that would be useful, bullets are helpful.) [comment]: # (Any other information that would be useful, bullets are helpful.)

8
.github/ISSUE_TEMPLATE/flakies.md vendored
View File

@@ -1,4 +1,5 @@
# What # What
Tests that fail randomly are called "flakies", this one seems to be one: Tests that fail randomly are called "flakies", this one seems to be one:
**Randomized seed:** FILL_WITH_RANDOM_SEED **Randomized seed:** FILL_WITH_RANDOM_SEED
@@ -12,13 +13,16 @@ Tests that fail randomly are called "flakies", this one seems to be one:
``` ```
# How # How
- [ ] Explain why the test is flaky, or under which conditions/scenario it fails randomly - [ ] Explain why the test is flaky, or under which conditions/scenario it fails randomly
- [ ] Explain why your PR fixes it - [ ] Explain why your PR fixes it
## Tips for flaky hunting ## Tips for flaky hunting
### Random values issues ### Random values issues
If the problem comes from randomly generated values, running multiple times a single spec could help you reproduce the failure by running at your command line: If the problem comes from randomly generated values, running multiple times a single spec could help you reproduce the failure by running at your command line:
```bash ```bash
for run in {1..10} for run in {1..10}
do do
@@ -28,6 +32,7 @@ done
You can also try running a single spec: You can also try running a single spec:
Add option `:focus` to the spec and push your branch to Github, for example: Add option `:focus` to the spec and push your branch to Github, for example:
```ruby ```ruby
scenario 'Show', :focus do scenario 'Show', :focus do
``` ```
@@ -35,16 +40,19 @@ scenario 'Show', :focus do
But remember to remove that `:focus` changes afterwards when submitting your PR changes! But remember to remove that `:focus` changes afterwards when submitting your PR changes!
### Test order issues ### Test order issues
Running specs in the order they failed may discover that the problem is that a previous test sets an state in the test environment that makes our flaky fail/pass. Tests should be independent from the rest. Running specs in the order they failed may discover that the problem is that a previous test sets an state in the test environment that makes our flaky fail/pass. Tests should be independent from the rest.
After executing rspec you can see the seed used, add it as an option to rspec, for example: After executing rspec you can see the seed used, add it as an option to rspec, for example:
`bin/rspec --seed 55638` (check **Randomized seed** value at beginning of issue) `bin/rspec --seed 55638` (check **Randomized seed** value at beginning of issue)
### Other things to watch for ### Other things to watch for
- Time related issues (current time, two time or date comparisons with miliseconds/time when its not needed) - 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 - https://semaphoreci.com/community/tutorials/how-to-deal-with-and-eliminate-flaky-tests
### Final thoughts ### 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). 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?". 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?".