mirror of https://github.com/OpenMW/openmw
[DOC] Update with Capo-LLM suggestions
This commit is contained in:
Sarah Sunday
parent
5a4e191325
commit
66e8d8e01e
|
|
@ -1,19 +1,44 @@
|
|||
If you're reporting an issue specific to an OpenMW fork, e.g. [TES3MP](https://github.com/TES3MP/openmw-tes3mp/issues) for multiplayer or [OpenMW-VR](https://gitlab.com/madsbuvi/openmw/-/issues) for OpenXR VR, please report it to that fork's author instead of here. Mod list issues or mod installer issues also do not belong here.
|
||||
<!--
|
||||
PLEASE READ THIS BEFORE POSTING:
|
||||
If you're reporting an issue specific to an OpenMW fork:
|
||||
- TES3MP (Multiplayer): Report at https://github.com/TES3MP/openmw-tes3mp/issues
|
||||
- OpenMW-VR: Report at https://gitlab.com/madsbuvi/openmw/-/issues
|
||||
|
||||
If you're reporting an issue specific to an open merge request, report it in the comments for the merge request instead.
|
||||
Mod list issues or mod installer issues do not belong here.
|
||||
If reporting an issue with a specific Merge Request, comment on the MR itself.
|
||||
-->
|
||||
|
||||
Describe the issue as detailed as you can. Below is a list of questions that should be answered in the description (if they apply).
|
||||
## Issue Description
|
||||
|
||||
- Is the problem OpenMW specific or does it also happen in vanilla Morrowind?
|
||||
- What is your operating system?
|
||||
- What version of OpenMW are you using?
|
||||
- If you used a bleeding edge build, state the exact revision used.
|
||||
- What version of Morrowind are you using (i.e. retail CD or Steam)? What addons (Tribunal, Bloodmoon) do you have installed?
|
||||
- What language is your Morrowind install?
|
||||
- Do you use any mods?
|
||||
- If so, does the problem also occur in a clean vanilla install without any mods?
|
||||
- What are the exact steps to reproduce the problem?What did you expect to happen?
|
||||
- What happened instead?
|
||||
- Are there any error messages in your openmw.log file? If you're not an OpenMW team member, it's best to upload it.
|
||||
- What settings do you use? If you're not an OpenMW team member, it's best to upload your settings.cfg.
|
||||
- Where is the in-game location this problem can be observed? Avoid vague statements such as "west of town X". Instead, open the console (` key by default, the key above Tab), click on the problematic object, then use the betacomment (bc) instruction to get useful information about the object that you can copy and paste into the bugreport:
|
||||
<!-- Describe the issue in as much detail as you can. -->
|
||||
|
||||
## Steps to Reproduce
|
||||
|
||||
<!--
|
||||
1. Open the game
|
||||
2. Go to '...'
|
||||
3. Click on '...'
|
||||
-->
|
||||
|
||||
## System Information
|
||||
|
||||
* **OpenMW Version:** <!-- e.g. 0.50.0 or Revision 945c3a... -->
|
||||
* **Operating System & Version:**
|
||||
* **GPU:**
|
||||
* **Morrowind Version:** <!-- Retail CD, Steam, GOG? -->
|
||||
* **Language:** <!-- e.g. English -->
|
||||
* **Addons:** <!-- Tribunal, Bloodmoon? -->
|
||||
|
||||
## Mods
|
||||
|
||||
* **Are you using mods?** Yes/No
|
||||
* **Are you using postprocessing or non-default shaders?** Yes/No
|
||||
* **Does it happen in a clean vanilla install?** Yes/No/Untested
|
||||
|
||||
## Logs and Settings
|
||||
|
||||
<!--
|
||||
Please attach your openmw.log and settings.cfg files.
|
||||
If the issue is graphical or location-based, please paste the output of the 'bc' command below.
|
||||
(Open console with ` -> Click object -> type 'bc')
|
||||
-->
|
||||
|
|
|
|||
|
|
@ -1,17 +1,33 @@
|
|||
Closes or related to*: #ISSUE_NUMBER
|
||||
<!--
|
||||
Identify the issue number this MR fixes or relates to.
|
||||
Use "Closes #123" if it fixes the issue, or "Related to #123" if it references it.
|
||||
-->
|
||||
|
||||
*_[Refer to GitLab documentation for the proper terms to use for closing/referring to issues](https://docs.gitlab.com/user/project/issues/managing_issues/#closing-issues-automatically). Choose 'closes' if your MR implements/fixes the issue and related to if it does not but should be referenced._
|
||||
Closes #
|
||||
|
||||
Provide a description of your changes. **No LLM Descriptions, please.**
|
||||
## Description
|
||||
|
||||
Some things to include:
|
||||
<!--
|
||||
Provide a description of your changes.
|
||||
Reasoning, approach, and any specific architectural decisions.
|
||||
PLEASE: No LLM/AI generated descriptions. Write this yourself.
|
||||
-->
|
||||
|
||||
- Reasoning for changes
|
||||
- Questions/concerns
|
||||
- Any steps to replicate/confirm
|
||||
- Remaining TODO items
|
||||
- If there's any supporting files or assets needed to review your MR, please link to them or include them.
|
||||
## Checklist
|
||||
|
||||
Please review [the project CONTRIBUTING guidelines](https://gitlab.com/OpenMW/openmw/-/blob/master/CONTRIBUTING.md?ref_type=heads) before raising your MR for review.
|
||||
Mark as done if not applicable.
|
||||
|
||||
Thank you!
|
||||
- [ ] I have read the [CONTRIBUTING guidelines](https://gitlab.com/OpenMW/openmw/-/blob/master/CONTRIBUTING.md)
|
||||
- [ ] My code builds and runs locally
|
||||
- [ ] I have included steps to replicate/confirm the changes below
|
||||
- [ ] I have attached necessary supporting files or assets
|
||||
|
||||
## Steps to Test/Replicate
|
||||
|
||||
1. ...
|
||||
2. ...
|
||||
3. ...
|
||||
|
||||
## Outstanding TODOs / Questions
|
||||
|
||||
- [ ] ...
|
||||
|
|
|
|||
Loading…
Reference in New Issue