summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcarsakiller <carsakiller@gmail.com>2024-08-12 22:29:59 -0400
committerGitHub <noreply@github.com>2024-08-12 22:29:59 -0400
commit01c6b6136da46573a4c2a1e581e35ca21d4f9b1e (patch)
treeed608109a39dfe8676983a2f04216f18e00ae616
parentaaf16240f77bb75a3d8db89c2a99934c8b6022ee (diff)
downloadlua-language-server-01c6b6136da46573a4c2a1e581e35ca21d4f9b1e.zip
GitHub issue templates (#2796)
* add: documentation template * add: issue template config
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml5
-rw-r--r--.github/ISSUE_TEMPLATE/doc-report.yml34
2 files changed, 39 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000..b39e5efb
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+ - name: Report LuaLS.github.io issues
+ url: https://github.com/LuaLS/LuaLS.github.io/issues
+ about: Please report issues regarding our website (and the documentation on it) in the website repository.
diff --git a/.github/ISSUE_TEMPLATE/doc-report.yml b/.github/ISSUE_TEMPLATE/doc-report.yml
new file mode 100644
index 00000000..3f0fa2b7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/doc-report.yml
@@ -0,0 +1,34 @@
+name: Documentation Report
+description: Report an issue with documentation in the lua-language-server.
+labels:
+ - documentation
+assignees:
+ - carsakiller
+body:
+ - type: markdown
+ attributes:
+ value: >
+ For issues with our [website](https://luals.github.io) and its wiki,
+ please visit the [correct repository](https://github.com/LuaLS/LuaLS.github.io/issues).
+ - type: markdown
+ attributes:
+ value: >
+ **Please check for similar issues before continuing!**
+ - type: textarea
+ id: expected
+ attributes:
+ label: Issue Description
+ description: Please describe the documentation issue. Is something incorrect, missing or improveable?
+ validations:
+ required: true
+ - type: textarea
+ id: additional-notes
+ attributes:
+ label: Additional Notes
+ description: >
+ Please provide any additional notes, context,
+ and media you have.
+ - type: markdown
+ attributes:
+ value: |
+ Thank you very much for helping improve the language server! ❤️