From a5500edc555f6d4429b3b697392f5f27215cb1db Mon Sep 17 00:00:00 2001 From: dav1312 <63931154+dav1312@users.noreply.github.com> Date: Tue, 25 Oct 2022 11:15:00 +0200 Subject: [PATCH] Add issue template Add an issue template using GitHub's form schema https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema closes https://github.com/official-stockfish/Stockfish/pull/4210 No functional change. --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 65 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++++ README.md | 63 +++++++++++++------------- 3 files changed, 106 insertions(+), 30 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/BUG-REPORT.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml new file mode 100644 index 00000000..e46d2bf8 --- /dev/null +++ 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: | + ``` + position startpos moves g2g4 e7e5 f2f3 + go mate 1 + info string NNUE evaluation using nn-6877cd24400e.nnue enabled + info depth 1 seldepth 1 multipv 1 score mate 1 nodes 33 nps 11000 tbhits 0 time 3 pv d8h4 + bestmove d8h4 + ``` + 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: Stockfish version + description: | + This can be found by running the engine. + You can also use the commit ID. + placeholder: Stockfish 15 / e6e324e + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..1f8694d2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Discord server + url: https://discord.gg/GWDRS3kU6R + 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/official-stockfish/Stockfish/discussions/new + about: Do you have an idea for Stockfish? Do you want to show something that you made? Please open a discussion about it! diff --git a/README.md b/README.md index b076ab6b..7066db4b 100644 --- a/README.md +++ b/README.md @@ -344,33 +344,36 @@ source code, these changes must also be made available under the GPL v3. For full details, read the copy of the GPL v3 found in the file named [*Copying.txt*][license-link]. -[authors-link]:https://github.com/official-stockfish/Stockfish/blob/master/AUTHORS -[build-badge]:https://img.shields.io/github/workflow/status/official-stockfish/Stockfish/Stockfish?style=for-the-badge&label=stockfish&logo=github -[build-link]:https://github.com/official-stockfish/Stockfish/actions/workflows/stockfish.yml -[commits-badge]:https://img.shields.io/github/commits-since/official-stockfish/Stockfish/latest?style=for-the-badge -[commits-link]:https://github.com/official-stockfish/Stockfish/commits/master -[discord-badge]:https://img.shields.io/discord/435943710472011776?style=for-the-badge&label=discord&logo=Discord -[discord-link]:https://discord.com/invite/aefaxmq -[fishcooking-link]:https://groups.google.com/g/fishcooking -[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%3A%2F%2Ftests.stockfishchess.org%2Ftests -[fishtest-link]:https://tests.stockfishchess.org/tests -[github-link]:https://github.com/official-stockfish/Stockfish -[guideline-link]:https://github.com/glinscott/fishtest/wiki/Creating-my-first-test -[license-badge]:https://img.shields.io/github/license/official-stockfish/Stockfish?style=for-the-badge&label=license&color=success -[license-link]:https://github.com/official-stockfish/Stockfish/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 -[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/official-stockfish/Stockfish/blob/master/README.md -[release-badge]:https://img.shields.io/github/v/release/official-stockfish/Stockfish?style=for-the-badge&label=official%20release -[release-link]:https://github.com/official-stockfish/Stockfish/releases/latest -[src-link]:https://github.com/official-stockfish/Stockfish/tree/master/src -[stockfish128-logo]:https://stockfishchess.org/images/logo/icon_128x128.png -[tools-link]:https://github.com/official-stockfish/Stockfish/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%3A%2F%2Fstockfishchess.org -[website-link]:https://stockfishchess.org -[worker-link]:https://github.com/glinscott/fishtest/wiki/Running-the-worker:-overview + +[authors-link]: https://github.com/official-stockfish/Stockfish/blob/master/AUTHORS +[build-link]: https://github.com/official-stockfish/Stockfish/actions/workflows/stockfish.yml +[commits-link]: https://github.com/official-stockfish/Stockfish/commits/master +[discord-link]: https://discord.gg/GWDRS3kU6R +[fishcooking-link]: https://groups.google.com/g/fishcooking +[fishtest-link]: https://tests.stockfishchess.org/tests +[github-link]: https://github.com/official-stockfish/Stockfish +[guideline-link]: https://github.com/glinscott/fishtest/wiki/Creating-my-first-test +[license-link]: https://github.com/official-stockfish/Stockfish/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 +[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/official-stockfish/Stockfish/blob/master/README.md +[release-link]: https://github.com/official-stockfish/Stockfish/releases/latest +[src-link]: https://github.com/official-stockfish/Stockfish/tree/master/src +[stockfish128-logo]: https://stockfishchess.org/images/logo/icon_128x128.png +[tools-link]: https://github.com/official-stockfish/Stockfish/tree/tools +[uci-link]: https://www.shredderchess.com/download/div/uci.zip +[website-link]: https://stockfishchess.org +[worker-link]: https://github.com/glinscott/fishtest/wiki/Running-the-worker:-overview + +[build-badge]: https://img.shields.io/github/workflow/status/official-stockfish/Stockfish/Stockfish?style=for-the-badge&label=stockfish&logo=github +[commits-badge]: https://img.shields.io/github/commits-since/official-stockfish/Stockfish/latest?style=for-the-badge +[discord-badge]: https://img.shields.io/discord/435943710472011776?style=for-the-badge&label=discord&logo=Discord +[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%3A%2F%2Ftests.stockfishchess.org%2Ftests +[license-badge]: https://img.shields.io/github/license/official-stockfish/Stockfish?style=for-the-badge&label=license&color=success +[release-badge]: https://img.shields.io/github/v/release/official-stockfish/Stockfish?style=for-the-badge&label=official%20release + +[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%3A%2F%2Fstockfishchess.org -- 2.39.2