Skip to content

Commit

Permalink
docs: elaborate on a minimal example
Browse files Browse the repository at this point in the history
Also improve formatting and update YAFC to Yafc.
  • Loading branch information
shpaass authored Feb 2, 2025
1 parent f79dedc commit c7fa6c6
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions .github/ISSUE_TEMPLATE/generic-bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ assignees: ''

---

- Make sure that you are using the latest available version of YAFC.
- Specify the YAFC version on which the bug happened.
- Make sure that you are using the latest available version of Yafc.
- Specify the Yafc version on which the bug happened.

- Please check the issues of [Yafc-ce](https://github.com/have-fun-was-taken/yafc-ce/issues) and the [original Yafc](https://github.com/ShadowTheAge/yafc/issues) to see if your problem is not a duplicate of another open or closed issue.
- Give as much relevant info as possible. The better you describe the issue, the bigger the chance that someone fixes it.
- If the bug is about mods, then attach a new-game save-file so we can sync the mods with yours.
- If the bug is about your .yafc project, such as errors in calculations, then attach your .yafc file.
- Describe the steps to reproduce the issue, the expected result, and the actual result.
- If possible, please provide a minimal example to reproduce the issue. Check if the bug can be reproduced on a fresh Yafc project, and try to use as few mods as possible. For mods selection, you can copy the mods folder, select it in Yafc, and edit the file mod-list.json to enable or disable mods.
- If relevant, please provide a minimal example:
In other words, please try to reproduce the bug on a fresh Yafc project when using as few mods as possible for that.
For mod selection, you can copy the mods folder, edit the file `mod-list.json` to enable or disable mods, and then select this folder in Yafc.

0 comments on commit c7fa6c6

Please sign in to comment.