feat(github): templates and CI

This feature focuses on extending our GitHub experience, it includes: * Issue templates and links to other repos * PR template * Automation of labelling and closing of issues/PRs * CI build checks - FiveM & RedM - FXServer (Windows only, Linux is disabled for now) * build.sh curl required explicit --http1.1 to work on GitHub runners
citizenfx · Nov 24, 2023 · 4063008 · blattersturm · Dec 14, 2023 · 4063008
1 parent 3e793d3
commit 4063008
Show file tree

Hide file tree

Showing 12 changed files with 853 additions and 1 deletion.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,98 @@
+name: Bug Report
+description: File a bug report to FiveM, RedM, FXServer, or FxDK, excluding crashes
+labels: ["bug", "triage"]
+assignees:
+  - 
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to fill out this bug report.
+        Only bug related issues are accepted, so please refrain from submitting any other requests (including support requests).
+        
+        \* Issue reports that fail to deliver the proper information may be closed without any feedback.
+  
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: |
+        Please be clear and concise
+      placeholder: 
+    validations:
+      required: true
+
+  - type: input
+    id: expectation
+    attributes:
+      label: Expected result
+      description: |
+        What should've happened instead?
+    validations:
+      required: true
+
+  - type: textarea
+    id: repro
+    attributes:
+      label: Reproduction steps
+      description: |
+        This is important to us. Fill in the exact steps you took, test and remove any steps that aren't relevant.
+      placeholder: |
+        1. 
+        2. 
+        3. 
+        4. 
+    validations:
+      required: true
+
+  - type: dropdown
+    id: importancy
+    attributes:
+      label: Importancy
+      description: |
+        To your knowledge how would you describe the importancy of this bug?
+      options:
+        - Unknown
+        - Slight inconvenience
+        - There's a workaround
+        - Security issue
+        - Crash
+    validations:
+      required: true
+
+  - type: dropdown
+    id: areas
+    attributes:
+      label: Area(s)
+      multiple: true
+      description: |
+        Which of the following areas does this issue apply to? Please mark all that apply.
+      options:
+        - FiveM
+        - RedM
+        - FXServer
+        - FxDK
+        - 'OneSync'
+        - 'Natives'
+        - 'ScRT: Lua'
+        - 'ScRT: C#'
+        - 'ScRT: JS'
+    validations:
+      required: true
+
+  - type: input
+    id: build-number
+    attributes:
+      label: Specific version(s)
+      description: Please fill in the build numbers of the product(s) this issue occured on
+      placeholder: FiveM/RedM 6464, Server 6402 windows/linux
+    validations:
+      required: true
+
+  - type: textarea
+    id: misc
+    attributes:
+      label: Additional information
+      description: |
+        Anything else you'd like to add?
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,13 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Public Documentation (docs.fivem.net)
+    url: https://github.com/citizenfx/fivem-docs
+    about: For all docs.fivem.net related requests and issues
+
+  - name: FiveM native documentation
+    url: https://github.com/citizenfx/natives
+    about: For issues related to FiveM game natives
+
+  - name: RedM native documentation
+    url: https://github.com/citizenfx/natives_rdr3
+    about: For issues related to RedM game natives
diff --git a/.github/ISSUE_TEMPLATE/docs_improvement.yml b/.github/ISSUE_TEMPLATE/docs_improvement.yml
@@ -0,0 +1,77 @@
+name: Documentation Improvement
+description: Improve request for FiveM, RedM, or FXServer's documentation
+labels: ["documentation", "triage"]
+assignees:
+  - 
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to fill out this documentation improvement request.
+        Only documentation related requests are accepted, so please refrain from submitting any other requests (including support requests).
+        
+        Any requests on documentation found on https://docs.fivem.net/docs/ need to go to https://github.com/citizenfx/fivem-docs.
+        
+        \* Requests that fail to deliver the proper information may be closed without any feedback.
+  
+  - type: input
+    id: segment 
+    attributes:
+      label: Segment
+      description: |
+        Which segment is this targeting? e.g.: type, method, field, or property
+      placeholder: 
+    validations:
+      required: true
+
+  - type: dropdown
+    id: importancy
+    attributes:
+      label: Importancy
+      description: |
+        To your knowledge how would you describe the importancy of this feature?
+      options:
+        - Unknown
+        - Nice extra
+        - Missing details
+        - Unclear or unintuitive
+        - Incorrect
+    validations:
+      required: true
+
+  - type: textarea
+    id: improvement
+    attributes:
+      label: Improvement request
+      description: |
+        Tell us what needs to be changed to make this better, also add suggestions if you have any
+    validations:
+      required: true
+
+  - type: dropdown
+    id: areas
+    attributes:
+      label: Area(s)
+      multiple: true
+      description: |
+        Which of the following areas does this request apply to? Please mark all that apply.
+      options:
+        - FiveM
+        - RedM
+        - FXServer
+        - FxDK
+        - 'OneSync'
+        - 'Natives'
+        - 'ScRT: Lua'
+        - 'ScRT: C#'
+        - 'ScRT: JS'
+    validations:
+      required: true
+
+  - type: textarea
+    id: misc
+    attributes:
+      label: Additional information
+      description: |
+        Anything else you'd like to add?
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml.disabled b/.github/ISSUE_TEMPLATE/feature_request.yml.disabled
@@ -0,0 +1,74 @@
+name: Feature Request
+description: Need FiveM, RedM, or FXServer to support something?
+labels: ["enhancement", "triage"]
+assignees:
+  - 
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to fill out this feature request.
+        Only feature requests are accepted, so please refrain from submitting any other requests (including support requests).
+
+        \* Requests that fail to deliver the proper information may be closed without any feedback.
+
+  - type: textarea
+    id: goal
+    attributes:
+      label: Goal
+      description: |
+        Please be clear and concise and make sure you focus on the **X** in [XY Problems](https://xyproblem.info/)
+      placeholder: 
+    validations:
+      required: true
+
+  - type: dropdown
+    id: importancy
+    attributes:
+      label: Importancy
+      description: |
+        To your knowledge how would you describe the importancy of this feature?
+      options:
+        - Unknown
+        - Nice extra
+        - Quality of Life (QoL)
+        - Overall quality to the platform
+        - Prerequisite for my project
+        - Fatal (we can't use the platform without)
+
+  - type: textarea
+    id: implementation
+    attributes:
+      label: API and/or potential implementation
+      description: |
+        Tell us what the user interface will look like and maybe a potential implementation
+    validations:
+      required: true
+
+  - type: dropdown
+    id: areas
+    attributes:
+      label: Area(s)
+      multiple: true
+      description: |
+        Which of the following areas does this request apply to? Please mark all that apply.
+      options:
+        - FiveM
+        - RedM
+        - FXServer
+        - FxDK
+        - 'OneSync'
+        - 'Natives'
+        - 'ScRT: Lua'
+        - 'ScRT: C#'
+        - 'ScRT: JS'
+    validations:
+      required: true
+
+  - type: textarea
+    id: misc
+    attributes:
+      label: Additional information
+      description: |
+        Anything else you'd like to add?
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,38 @@
+### Goal of this PR
+<!-- Consice explanation of what this PR meant to achieve -->
+
+...
+
+
+### How is this PR achieving the goal
+
+...
+
+
+### This PR applies to the following area(s)
+<!-- Add any that applies, e.g.: FiveM, RedM, Server, Natives, FxDK, ScRT: Lua, ScRT: C#, ScRT: JS, etc. -->
+
+...
+
+
+### Successfully tested on
+<!-- Add any that is applicable, remove any that aren't. -->
+
+**Game builds:** .. 
+
+**Platforms:** Windows, Linux
+
+
+### Checklist
+<!-- Mark all points with x that apply, i.e.: [x]. -->
+
+- [ ] Code compiles and has been tested successfully.
+- [ ] Code explains itself well and/or is documented.
+- [ ] My commit message explains what the changes do and what they are for.
+- [ ] No extra compilation warnings are added by these changes.
+
+
+### Fixes issues
+<!-- Add any issue that this PR fixes with: `fixes #123`, `resolves #234`, `closes #345`. -->
+
+