Skip to content

Commit 791f284

Browse files
authored
Merge pull request #2289 from asbjornu/feature/encourage-repository-fixture-tests
Encourage writing RepositoryFixture tests
2 parents 251645f + 94776e8 commit 791f284

File tree

3 files changed

+33
-5
lines changed

3 files changed

+33
-5
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,21 @@ A clear and concise description of what the bug is.
2020
<!-- Not obligatory, but suggest a fix or reason for the bug -->
2121

2222
## Steps to Reproduce
23-
<!-- Provide a link to a live example, or an unambiguous set of steps to -->
24-
<!-- reproduce this bug. Include code to reproduce, if relevant -->
23+
<!--
24+
If you are able to write your bug or scenario up as a `RepositoryFixture` test
25+
and submit a pull-request with it, it is going to increase the likelyhood of
26+
the bug being fixed.
27+
28+
It will both make it easier to understand what you are trying to achieve, how
29+
GitVersion deviates from this expectation and to start debugging the problem. It
30+
will also make it easier for you to fix the problem yourself. Please look at the
31+
following example for how such a test can look like:
32+
33+
https://github.com/GitTools/GitVersion/blob/251645f08802ea9dc401d5b2f2d681e8f8adf626/src/GitVersionCore.Tests/IntegrationTests/MasterScenarios.cs#L13-L32
34+
35+
Otherwise, please provide a link to a live example, or an unambiguous set of
36+
steps to reproduce this bug.
37+
-->
2538

2639
## Context
2740
<!-- How has this bug affected you? What were you trying to accomplish? -->

.github/ISSUE_TEMPLATE/failing-test.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ assignees: ''
1111
A clear and concise description of what the bug is or a link to it
1212

1313
## Test code
14-
```
14+
15+
```csharp
1516
using var fixture = new EmptyRepositoryFixture();
1617
fixture.Repository.MakeACommit();
1718
fixture.BranchTo("develop");

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,24 @@ assignees: ''
88
---
99

1010
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
A clear and concise description of what the problem is. Ex. I'm always
12+
frustrated when [...]
1213

1314
## Detailed Description
14-
<!--- Provide a detailed description of the change or addition you are proposing -->
15+
<!---
16+
Provide a detailed description of the change or addition you are proposing.
17+
18+
If you are able to write your feature or scenario up as a `RepositoryFixture`
19+
test and submit a pull-request with it, it is going to increase the likelyhood
20+
of the feature being implemented.
21+
22+
It will both make it easier to understand what you are trying to achieve, how
23+
GitVersion deviates from this expectation and to start debugging the problem. It
24+
will also make it easier for you to implement the feature yourself. Please look
25+
at the following example for how such a test can look like:
26+
27+
https://github.com/GitTools/GitVersion/blob/251645f08802ea9dc401d5b2f2d681e8f8adf626/src/GitVersionCore.Tests/IntegrationTests/MasterScenarios.cs#L13-L32
28+
-->
1529

1630
## Context
1731
<!--- Why is this change important to you? How would you use it? -->

0 commit comments

Comments
 (0)