diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 62f702f..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve or fix something -title: "[BUG]" -labels: bug -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. A stranger to qbcore should be able to read your bug report and understand how to reproduce it themselves and understand how the feature should work normally. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Use this item '....' (item's name from shared.lua if applicable) -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Questions (please complete the following information):** - - When you last updated: [e.g. last week] - - Are you using custom resource? which ones? [e.g. zdiscord, qb-target] - - Have you renamed `qb-` to something custom? [e.g. yes/no] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..e3f508c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,71 @@ +name: Bug report +description: Create a report to help us improve or fix something +title: "[BUG]" +labels: bug +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out a bug report! + Please use our Discord Server to ask questions and receive support: https://discord.gg/qbcore + - type: input + id: summary + attributes: + label: Summary + description: Write a short and concise description of your bug. + validations: + required: true + - type: textarea + id: repro + attributes: + label: Reproduction + description: What did you do to make this happen? + placeholder: | + 1. Using ... + 2. Do ... + 3. Then use ... + 4. See error + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + description: What did you expect to happen? + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual behavior + description: What actually happened? + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: If you have any other context about the problem such as screenshots or videos, add them here. + - type: input + id: updated + attributes: + label: Last Updated + description: When have you last updated? + placeholder: e.g. last week, today + validations: + required: true + - type: input + id: custom + attributes: + label: Custom Resources + description: Are you using custom resources? Which ones? + placeholder: e.g. zdiscord, qb-target + validations: + required: true + - type: input + id: renamed + attributes: + label: Resource Rename + description: Have you renamed this resource from `qb-` to something custom? + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..9601bc6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: QBCore Discord Server + url: https://discord.gg/qbcore + about: Ask questions, receive support, and discuss with the community in our Discord server. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 9e9bf3e..0000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature Request -about: Suggest an idea for QBCore -title: "[SUGGESTION]" -labels: enhancement -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. - -**Describe the feature you'd like** -A clear and concise description of what you want to happen. and with as much detail as possible how it would function in your opinion. Please try to keep it unique. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered for people to have in mind just in case the main idea isn't liked but a derivative is. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..9b0751f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,37 @@ +name: Feature request +description: Suggest an idea for QBCore +title: "[SUGGESTION]" +labels: enhancement +body: + - type: markdown + attributes: + value: | + Please use our Discord Server to ask questions and receive support: https://discord.gg/qbcore + - type: textarea + id: problem + attributes: + label: The problem + description: A clear and concise description of what the problem is, or what feature you want to be implemented. + placeholder: | + Some examples: + I'm frustrated that ... + It would be nice if ... + validations: + required: true + - type: textarea + id: solution + attributes: + label: Ideal solution + description: A clear and concise description of what you want to happen, with as much detail as possible. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternative solutions + description: A clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: additional + attributes: + label: Additional context + description: If you have any other context about the problem such as screenshots or videos, add them here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 000f0f9..d80e172 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,10 +1,11 @@ -**Describe Pull request** -First, make sure you've read and are following the contribution guidelines and style guide and your code reflects that. -Write up a clear and concise description of what your pull request adds or fixes and if it's an added feature explain why you think it should be included in the core. +## Description -If your PR is to fix an issue mention that issue here + -**Questions (please complete the following information):** -- Have you personally loaded this code into an updated qbcore project and checked all it's functionality? [yes/no] (Be honest) -- Does your code fit the style guidelines? [yes/no] -- Does your PR fit the contribution guidelines? [yes/no] +## Checklist + + + +- [ ] I have personally loaded this code into an updated qbcore project and checked all of its functionality. +- [ ] My code fits the style guidelines. +- [ ] My PR fits the contribution guidelines. diff --git a/.gitignore b/.gitignore index d096d85..3b6a158 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ # Ignore any IDE derived project configs .idea -.vscode \ No newline at end of file +.vscode/* +!.vscode/extensions.json +!.vscode/settings.json \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..a5801a5 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,10 @@ +{ + "recommendations": [ + "sumneko.lua", + "fivem-vscode.fivem-vscode", + "ihyajb.qbcore-code-snippets", + "EditorConfig.EditorConfig", + "eamodio.gitlens", + "GitHub.vscode-pull-request-github" + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..4d79df9 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,4 @@ +{ + "Lua.runtime.nonstandardSymbol": ["/**/", "`", "+=", "-=", "*=", "/="], + "Lua.runtime.version": "Lua 5.4" +} \ No newline at end of file