Skip to content

Commit 126b6ff

Browse files
authored
Merge pull request #164 from projectsyn/docs/issue-template-inventory-sharing-steps
Update bug report and missing feature issue templates
2 parents 6dbcd37 + 9aee68c commit 126b6ff

2 files changed

Lines changed: 27 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE/01_bug_report.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,23 @@ labels: bug
1313
1.
1414
1.
1515

16+
## Example Reclass inventory
17+
<!--
18+
If at all feasible, please provide a minimal example inventory that
19+
demonstrates the buggy behavior. By doing so, you're making it much easier for
20+
us to fix the reported bug.
21+
22+
You can share an example inventory as follows:
23+
24+
1. Setup the example inventory structure (including `reclass-config.yml` if
25+
necessary) in a temporary directory
26+
2. Verify that the example inventory demonstrates the buggy behavior
27+
3. Run `tar cj * | base64 -w 0` in the temporary directory
28+
On macOS, you'll need to leave out `-w 0`.
29+
4. Copy the resulting base64 string into a code block in this section
30+
5. If you've changed the `tar` command, please provide your version
31+
-->
32+
1633
## Actual Behavior
1734
<!-- What did happen as a result of the above? -->
1835

.github/ISSUE_TEMPLATE/03_missing_reclass_feature.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,14 @@ the full `reclass-config.yml` that you're using.
2222
If feasible, please provide a minimal example inventory that makes use of the
2323
missing feature. By doing so, you're making it much easier for us to implement
2424
and test the missing feature.
25+
26+
You can share an example inventory as follows:
27+
28+
1. Setup the example inventory structure (including `reclass-config.yml` if
29+
necessary) in a temporary directory
30+
2. Verify that the example inventory demonstrates the buggy behavior
31+
3. Run `tar cj * | base64 -w 0` in the temporary directory
32+
On macOS, you'll need to leave out `-w 0`.
33+
4. Copy the resulting base64 string into a code block in this section
34+
5. If you've changed the `tar` command, please provide your version
2535
-->

0 commit comments

Comments
 (0)