Add issue template

huynq55 · Oct 28, 2022 · 15263a1 · 15263a1
1 parent 0e41085
commit 15263a1
Show file tree

Hide file tree

Showing 3 changed files with 103 additions and 30 deletions.
diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
@@ -0,0 +1,65 @@
+name: Report issue
+description: Create a report to help us fix issues with the engine
+body:
+- type: textarea
+  attributes:
+    label: Describe the issue
+    description: A clear and concise description of what you're experiencing.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Expected behavior
+    description: A clear and concise description of what you expected to happen.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Steps to reproduce
+    description: |
+      Steps to reproduce the behavior.
+      You can also use this section to paste the command line output.
+    placeholder: |
+      ```
+      startpos
+      go depth 1
+      info string NNUE evaluation using pikafish.nnue enabled
+      info depth 1 seldepth 1 multipv 1 score cp 68 nodes 51 nps 17000 hashfull 0 tbhits 0 time 3 pv h0g2
+      bestmove h0g2
+      ```
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Anything else?
+    description: |
+      Anything that will give us more context about the issue you are encountering.
+      You can also use this section to propose ideas on how to solve the issue. 
+  validations:
+    required: false
+
+- type: dropdown
+  attributes:
+    label: Operating system
+    options:
+      - All
+      - Windows
+      - Linux
+      - MacOS
+      - Android
+      - Other or N/A
+  validations:
+    required: true
+
+- type: input
+  attributes:
+    label: Pikafish version
+    description: |
+      This can be found by running the engine.
+      You can also use the commit ID.
+    placeholder: Pikafish 2022-10-22 / 5d0cd46
+  validations:
+    required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discord server
+    url: https://discord.com/invite/uSb3RXb7cY
+    about: Feel free to ask for support or have a chat with us in our Discord server!
+  - name: Discussions, Q&A, ideas, show us something...
+    url: https://github.com/PikaCat-OuO/Pikafish/discussions/new
+    about: Do you have an idea for Pikafish? Do you want to show something that you made? Please open a discussion about it!
diff --git a/README.md b/README.md
@@ -279,33 +279,33 @@ The engine testing is done on [Fishtest][fishtest-link].
 If you want to help improve Pikafish, please read this [guideline][guideline-link]
 first, where the basics of Pikafish development are explained.
 
-[authors-link]:https://github.com/PikaCat-OuO/Pikafish/blob/master/AUTHORS
-[build-badge]:https://img.shields.io/github/workflow/status/PikaCat-OuO/Pikafish/Pikafish?style=for-the-badge&label=pikafish&logo=github
-[build-link]:https://github.com/PikaCat-OuO/Pikafish/actions/workflows/pikafish.yml
-[commits-badge]:https://img.shields.io/github/commits-since/PikaCat-OuO/Pikafish/latest?style=for-the-badge
-[commits-link]:https://github.com/PikaCat-OuO/Pikafish/commits/master
-[discord-badge]:https://img.shields.io/discord/1013130558089478144?style=for-the-badge&label=discord&logo=Discord
-[discord-link]:https://discord.com/invite/uSb3RXb7cY
-[qqgroup-link]:https://jq.qq.com/?_wv=1027&k=FORWUh4W
-[fishtest-badge]:https://img.shields.io/website?style=for-the-badge&down_color=red&down_message=Offline&label=Fishtest&up_color=success&up_message=Online&url=https://test.pikafish.org
-[fishtest-link]:https://test.pikafish.org
-[github-link]:https://github.com/PikaCat-OuO/Pikafish
-[guideline-link]:https://github.com/glinscott/fishtest/wiki/Creating-my-first-test
-[license-badge]:https://img.shields.io/github/license/PikaCat-OuO/Pikafish?style=for-the-badge&label=license&color=success
-[license-link]:https://github.com/PikaCat-OuO/Pikafish/blob/master/Copying.txt
-[lockpages-link]:https://docs.microsoft.com/en-us/sql/database-engine/configure-windows/enable-the-lock-pages-in-memory-option-windows
-[nnue-license-link]:https://github.com/PikaCat-OuO/Pikafish/blob/master/NNUE-License.txt
-[nodchip-link]:https://github.com/nodchip/Stockfish
-[programming-link]:https://www.chessprogramming.org/Main_Page
-[programmingsf-link]:https://www.chessprogramming.org/Stockfish
-[pytorch-link]:https://github.com/glinscott/nnue-pytorch
-[rammap-link]:https://docs.microsoft.com/en-us/sysinternals/downloads/rammap
-[readme-link]:https://github.com/PikaCat-OuO/Pikafish/blob/master/README.md
-[release-badge]:https://img.shields.io/github/v/release/PikaCat-OuO/Pikafish?style=for-the-badge&label=official%20release
-[release-link]:https://github.com/PikaCat-OuO/Pikafish/releases/latest
-[src-link]:https://github.com/PikaCat-OuO/Pikafish/tree/master/src
-[tools-link]:https://github.com/PikaCat-OuO/Pikafish/tree/tools
-[uci-link]:https://www.shredderchess.com/download/div/uci.zip
-[website-badge]:https://img.shields.io/website?style=for-the-badge&down_color=red&down_message=Offline&label=website&up_color=success&up_message=Online&url=https://pikafish.org
-[website-link]:https://pikafish.org
-[worker-link]:https://github.com/xyztnecniV/yolo
+[authors-link]:			https://github.com/PikaCat-OuO/Pikafish/blob/master/AUTHORS
+[build-badge]:			https://img.shields.io/github/workflow/status/PikaCat-OuO/Pikafish/Pikafish?style=for-the-badge&label=pikafish&logo=github
+[build-link]:				https://github.com/PikaCat-OuO/Pikafish/actions/workflows/pikafish.yml
+[commits-badge]:		https://img.shields.io/github/commits-since/PikaCat-OuO/Pikafish/latest?style=for-the-badge
+[commits-link]:			https://github.com/PikaCat-OuO/Pikafish/commits/master
+[discord-badge]:			https://img.shields.io/discord/1013130558089478144?style=for-the-badge&label=discord&logo=Discord
+[discord-link]:			https://discord.com/invite/uSb3RXb7cY
+[qqgroup-link]:			https://jq.qq.com/?_wv=1027&k=FORWUh4W
+[fishtest-badge]:			https://img.shields.io/website?style=for-the-badge&down_color=red&down_message=Offline&label=Fishtest&up_color=success&up_message=Online&url=https://test.pikafish.org
+[fishtest-link]:			https://test.pikafish.org
+[github-link]:			https://github.com/PikaCat-OuO/Pikafish
+[guideline-link]:			https://github.com/glinscott/fishtest/wiki/Creating-my-first-test
+[license-badge]:			https://img.shields.io/github/license/PikaCat-OuO/Pikafish?style=for-the-badge&label=license&color=success
+[license-link]:			https://github.com/PikaCat-OuO/Pikafish/blob/master/Copying.txt
+[lockpages-link]:			https://docs.microsoft.com/en-us/sql/database-engine/configure-windows/enable-the-lock-pages-in-memory-option-windows
+[nnue-license-link]:		https://github.com/PikaCat-OuO/Pikafish/blob/master/NNUE-License.txt
+[nodchip-link]:			https://github.com/nodchip/Stockfish
+[programming-link]:		https://www.chessprogramming.org/Main_Page
+[programmingsf-link]:	https://www.chessprogramming.org/Stockfish
+[pytorch-link]:			https://github.com/glinscott/nnue-pytorch
+[rammap-link]:			https://docs.microsoft.com/en-us/sysinternals/downloads/rammap
+[readme-link]:			https://github.com/PikaCat-OuO/Pikafish/blob/master/README.md
+[release-badge]:			https://img.shields.io/github/v/release/PikaCat-OuO/Pikafish?style=for-the-badge&label=official%20release
+[release-link]:			https://github.com/PikaCat-OuO/Pikafish/releases/latest
+[src-link]:				https://github.com/PikaCat-OuO/Pikafish/tree/master/src
+[tools-link]:				https://github.com/PikaCat-OuO/Pikafish/tree/tools
+[uci-link]:				https://www.shredderchess.com/download/div/uci.zip
+[website-badge]:		https://img.shields.io/website?style=for-the-badge&down_color=red&down_message=Offline&label=website&up_color=success&up_message=Online&url=https://pikafish.org
+[website-link]:			https://pikafish.org
+[worker-link]:			https://github.com/xyztnecniV/yolo