Skip to content

Commit 7346760

Browse files
committed
Add links in CONTRIBUTING.md
This would help people to find explanation or reuse an existing issue when implementing it.
1 parent c16c666 commit 7346760

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

CONTRIBUTING.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,8 @@ Describe a new checker in [checkers section](./README.md#checkers).
178178

179179
**Autofix**: false. <br>
180180
**Enabled by default**: true. <br>
181-
**Reason**: The `Error()` method on the `error` interface exists for humans, not code.
181+
**Reason**: The `Error()` method on the `error` interface exists for humans, not code. <br>
182+
**Related issues**: [#47](https://github.com/Antonboom/testifylint/issues/47)
182183

183184
---
184185

@@ -311,14 +312,16 @@ And similar idea for `assert.InEpsilonSlice` / `assert.InDeltaSlice`.
311312

312313
**Autofix**: true. <br>
313314
**Enabled by default**: maybe? <br>
314-
**Reason**: More appropriate `testify` API with clearer failure message.
315+
**Reason**: More appropriate `testify` API with clearer failure message. <br>
316+
**Related issues**: [#76](https://github.com/Antonboom/testifylint/issues/76)
315317

316318
---
317319

318320
### no-fmt-mess
319321

320322
**Autofix**: true. <br>
321-
**Enabled by default**: maybe?
323+
**Enabled by default**: maybe? <br>
324+
**Related issues**: [#33](https://github.com/Antonboom/testifylint/issues/33)
322325

323326
Those who are new to `testify` may be discouraged by the duplicative API:
324327

@@ -391,7 +394,8 @@ func (s *Suite) TestSomething() {
391394

392395
**Autofix**: true. <br>
393396
**Enabled by default**: probably yes. <br>
394-
**Reason**: Code simplification and consistency.
397+
**Reason**: Code simplification and consistency. <br>
398+
**Related issues**: [#35](https://github.com/Antonboom/testifylint/issues/35)
395399

396400
But need to investigate the technical difference and the reasons for the appearance of `s.Run`.
397401
Also, maybe this case is already covered by [suite-dont-use-pkg](README.md#suite-dont-use-pkg)?
@@ -422,7 +426,8 @@ type BalanceSubscriptionSuite struct {
422426

423427
**Autofix**: true. <br>
424428
**Enabled by default**: false. <br>
425-
**Reason**: Just unification of approach.
429+
**Reason**: Just unification of approach. <br>
430+
**Related issues**: [#48](https://github.com/Antonboom/testifylint/issues/48)
426431

427432
Also, maybe to check the configurable format of subtest name? Mess example:
428433

@@ -470,7 +475,8 @@ assert.ErrorContains(t, err, "user") ❌
470475

471476
**Autofix**: true. <br>
472477
**Enabled by default**: false. <br>
473-
**Reason**: Just for your reflection and suggestion.
478+
**Reason**: Just for your reflection and suggestion. <br>
479+
**Related issues**: [#75](https://github.com/Antonboom/testifylint/issues/75)
474480

475481
I'm not sure if anyone uses `assert.Zero` – it looks strange and conflicts with `assert.Empty`:
476482

0 commit comments

Comments
 (0)