mirror of
https://github.com/Laupetin/OpenAssetTools.git
synced 2026-09-21 13:27:07 +00:00
docs: issue and pull request templates (#1017)
* docs: add a pull request template * Loosely based on the template of vitejs * docs: add bug report issue template * docs: link GitHub discussions in contributing.md
This commit is contained in:
@@ -0,0 +1,56 @@
|
||||
name: "🐞 Bug report"
|
||||
description: "File a bug report."
|
||||
title: "[Bug]: "
|
||||
labels: [ bug ]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to report a bug!
|
||||
- type: textarea
|
||||
id: bug-description
|
||||
attributes:
|
||||
label: Describe the bug
|
||||
description: A clear and concise description of what the bug is.
|
||||
placeholder: I am doing ... What I expect is ... What actually happening is ...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: reproduction-steps
|
||||
attributes:
|
||||
label: Steps to reproduce the issue
|
||||
description: |
|
||||
Please include a guide on how to reproduce the issue.
|
||||
Without being able to reproduce it, it most likely cannot be fixed.
|
||||
placeholder: e.g. compile the attached mod, load the attached asset file, use a specific snippet in a zone file, ...
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: oat-version
|
||||
attributes:
|
||||
label: OpenAssetTools version
|
||||
description: The version of OpenAssetTools you encountered the bug with. Can be checked with the `--version` flag. E.g. `./Linker --version`
|
||||
placeholder: v0.x.x
|
||||
- type: upload
|
||||
id: files
|
||||
attributes:
|
||||
label: Upload relevant files if any
|
||||
description: |
|
||||
Drag and drop any relevant files (like asset files to reproduce the issue) if there are any.
|
||||
Do not upload any copyrighted material like original assets of the game.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional information
|
||||
description: Any additional information regarding the issue you might want to share
|
||||
- type: checkboxes
|
||||
id: checkboxes
|
||||
attributes:
|
||||
label: Validations
|
||||
description: Before submitting the issue, please make sure you do the following
|
||||
options:
|
||||
- label: Read the [Contributing Guidelines](https://github.com/Laupetin/OpenAssetTools/blob/main/CONTRIBUTING.md).
|
||||
required: true
|
||||
- label: Check that there isn't [already an issue](https://github.com/Laupetin/OpenAssetTools/issues) that reports the same bug to avoid creating a duplicate.
|
||||
required: true
|
||||
- label: Make sure this is an OpenAssetTools issue and not a bug in the game, a game client you are using or another third party tool.
|
||||
required: true
|
||||
@@ -0,0 +1,11 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: 💡 Feature Request
|
||||
url: https://github.com/Laupetin/OpenAssetTools/discussions/new?category=ideas-feature-requests
|
||||
about: Please use GitHub discussions to make a feature request.
|
||||
- name: 📘 Documentation
|
||||
url: https://github.com/OpenAssetTools/Docs
|
||||
about: You can edit and submit user documentation in the OpenAssetTools/Docs repository.
|
||||
- name: 💬 Other
|
||||
url: https://github.com/Laupetin/OpenAssetTools/discussions
|
||||
about: For anything, feel free to reach out via GitHub discussions or discord.
|
||||
@@ -0,0 +1,16 @@
|
||||
<!--
|
||||
- What is this PR solving? Write a clear and concise description.
|
||||
- Reference related issues that are being solved (e.g. `fixes #123`).
|
||||
- Are there any parts you think require more attention from reviewers?
|
||||
- How can this PR be tested?
|
||||
|
||||
Also, please make sure you do the following:
|
||||
|
||||
- Read the contributing guidelines at https://github.com/Laupetin/OpenAssetTools/blob/main/CONTRIBUTING.md.
|
||||
- Check that there isn't already a PR that solves the problem the same way.
|
||||
- If you used AI-tooling, include a short notice stating in which ways these tools were used.
|
||||
|
||||
Do not use AI to generate the pull request description.
|
||||
|
||||
Thank you for making a contribution to OpenAssetTools!
|
||||
-->
|
||||
+4
-3
@@ -120,6 +120,7 @@ and work.
|
||||
|
||||
## Getting In Touch
|
||||
|
||||
The main communication platform for getting in touch regarding OAT is GitHub discussions right now. There is no
|
||||
dedicated Discord server for the project, however I am member in a bunch of CoD modding related servers, so discussions
|
||||
can also happen there. Additionally, you can also reach out via Discord PM.
|
||||
The main communication platform for getting in touch regarding OAT
|
||||
is [GitHub discussions](https://github.com/Laupetin/OpenAssetTools/discussions) right now. There is no dedicated Discord
|
||||
server for the project, however I am member in a bunch of CoD modding related servers, so discussions can also happen
|
||||
there. Additionally, you can also reach out via Discord PM.
|
||||
|
||||
Reference in New Issue
Block a user