diff options
| -rw-r--r-- | .github/ISSUE_TEMPLATE/issue.yml | 2 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/sql_fix.yml | 57 | ||||
| -rw-r--r-- | issue_template.md | 51 |
3 files changed, 58 insertions, 52 deletions
diff --git a/.github/ISSUE_TEMPLATE/issue.yml b/.github/ISSUE_TEMPLATE/issue.yml index 2601348e990..468fddabe40 100644 --- a/.github/ISSUE_TEMPLATE/issue.yml +++ b/.github/ISSUE_TEMPLATE/issue.yml @@ -1,5 +1,5 @@ name: Generic issue -description: Report an issue, a suggestion, SQL only fix. +description: Report an issue or a suggestion. body: - type: markdown attributes: diff --git a/.github/ISSUE_TEMPLATE/sql_fix.yml b/.github/ISSUE_TEMPLATE/sql_fix.yml new file mode 100644 index 00000000000..7112cec98bc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/sql_fix.yml @@ -0,0 +1,57 @@ +name: SQL fix +description: Suggest a SQL only fix. +labels: [Comp-Database, Feedback-PatchFix] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this form! Please make sure to fill all fields, including the Title above. + For SQL fixes: + - search for existing issues, if a bug report exist for the issue you are trying to fix and it's opened post there. + - don't modify WDB fields without supply one sniff of those fields (censure guids, character names, anything blizzard can use to identify source) + - don't use pull requests for sql only fixes, unless it's to fix one existing unable to apply file. + - don't hardcode guids. + - don't DELETE + INSERT to update only few fields of one row. + - don't use database names. + - don't put ' around numbers. + - don't put ( ) if they aren't needed. + - use only 1 DELETE + INSERT when we add multiple items to one table, unless you are scripting multiple creatures. + - start fix by -- in case some previous sql misses proper ending. + - DELETE by guid AND entry to be sure we don't delete existing spawns. + + The wiki page https://github.com/TrinityCore/TrinityCore/wiki/SQL-Fix includes additional details about how to fill this form and an example of a SQL fix. + - type: textarea + id: description + attributes: + label: Description + description: | + Description of what is getting fixed, including how to reproduce the issue if any. + validations: + required: true + - type: textarea + id: fix + attributes: + label: SQL fix + description: This field will be formatted automatically as SQL code block, no need to include \`\`\`sql + placeholder: | + -- + render: sql + validations: + required: true + - type: dropdown + id: branch + attributes: + label: Branch + options: + - 3.3.5 + - master + validations: + required: true + - type: textarea + id: commit + attributes: + label: TC rev. hash/commit + description: | + Copy the result of server debug command (if you need to run it from client get prat addon) + validations: + required: true diff --git a/issue_template.md b/issue_template.md deleted file mode 100644 index 885e65ccd93..00000000000 --- a/issue_template.md +++ /dev/null @@ -1,51 +0,0 @@ -<!--- (**********************************) - (** Fill in the following fields **) - (**********************************) - (you can delete all rows before description and after operating system when creating issue) - For SQL fixes: - search for existing issues, if a bug report exist for the issue you are trying to fix and it's opened post there. - don't modify WDB fields without supply one sniff of those fields (censure guids, character names, anything blizzard can use to identify source) - don't use pull requests for sql only fixes, unless it's to fix one existing unable to apply file. - don't hardcode guids. - don't DELETE + INSERT to update only few fields of one row. - don't use database names. - don't put ' around numbers. - don't put ( ) if they aren't needed. - use only 1 DELETE + INSERT when we add multiple items to one table, unless you are scripting multiple creatures. - put default values on every new column we want to add on that way we can make smallers inserts. - start fix by -- in case some previous sql misses proper ending. - DELETE by guid AND entry to be sure we don't delete existing spawns. - start sql code with 3 ` sql ---> - -**Description:** - -CHANGEME Description of the problem or issue here. -If this is a crash, post the crashlog (upload to https://gist.github.com/). - -**Expected behaviour:** - -CHANGEME Tell us what should happen instead. - -**Steps to reproduce the problem:** - -1. CHANGEME Step 1 include entries of affected creatures / items / quests with a link to the relevant wowhead page. -2. Step 2 -3. Step 3 - -**Branch(es):** - -CHANGEME 3.3.5, master or both - -**TC rev. hash/commit:** - -CHANGEME Copy the result of server debug command (if you need to run it from client get prat addon) - -**Operating system:** - -CHANGEME OS - - -<!--- Notes -- This template is for problem reports. For other types of report, edit it accordingly. -- For fixes containing C++ changes, create a Pull Request. ----> |