diff options
author | Juan Carlos <juancarlospaco@gmail.com> | 2022-08-04 06:15:22 -0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-08-04 11:15:22 +0200 |
commit | 2f3980f491a7d94facff6e0f7d413818a86267a1 (patch) | |
tree | 939eab93238c5be9c8976fb72203a843baa77518 | |
parent | a34dd3d77a3c76b5bb5c1939412f592c6fdbd771 (diff) | |
download | Nim-2f3980f491a7d94facff6e0f7d413818a86267a1.tar.gz |
Add bug form (#19913)
* Add Bug Form * Add Bug Form * Add Bug Form * Add Bug Form * https://github.com/nim-lang/Nim/pull/19913#issuecomment-1160663243 * https://github.com/nim-lang/Nim/pull/19913#issuecomment-1160663243 * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Yardanico <tiberiumk12@gmail.com> * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/feature_request.yml Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/feature_request.yml Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Do not Star Nim on Github * No backwards compat problems * Typo Co-authored-by: Yardanico <tiberiumk12@gmail.com> Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 53 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.yml | 214 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 35 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.yml | 73 |
4 files changed, 287 insertions, 88 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 807e50d35..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -name: Bug report -about: Have you found an unexpected behavior? Use this template. -title: Think about the title, twice -labels: '' -assignees: '' - ---- - -(Consider writing a PR targetting devel branch after filing this, see [contributing.html](https://nim-lang.github.io/Nim/contributing.html)). - -Function `echo` outputs the wrong string. - -### Example -```nim -echo "Hello World!" -# This code should be a minimum reproducible example: -# try to simplify and minimize as much as possible. If it's a compiler -# issue, try to minimize further by removing any imports if possible. -``` - -### Current Output -please check whether the problem still exists in git head before posting, -see [rebuilding the compiler](https://nim-lang.github.io/Nim/intern.html#rebuilding-the-compiler). -``` -Hola mundo! -``` - -### Expected Output -``` -Hello World! -``` - -### Possible Solution - -* In file xyz there is a call that might be the cause of it. - -### Additional Information -If it's a regression, you can help us by identifying which version introduced -the bug, see [Bisecting for regressions](https://nim-lang.github.io/Nim/intern.html#bisecting-for-regressions), -or at least try known past releases (eg `choosenim 1.2.0`). - -If it's a pre-existing compiler bug, see [Debugging the compiler](https://nim-lang.github.io/Nim/intern.html#debugging-the-compiler) -which should give more context on a compiler crash. - -* Issue #abc is related, but different because of ... -* This issue is blocking my project xyz - -``` -$ nim -v -Nim Compiler Version 0.1.2 -# make sure to include the git hash if not using a tagged release -``` diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..5b078131f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,214 @@ +name: "Bug Report" +description: "Create a new bug report. Have you found an unexpected behavior? Use this form." +title: "Think about the title, twice." +labels: ["unconfirmed"] +body: + +- type: markdown + attributes: + value: | + - **Please provide a minimal code example that reproduces the Bug!** :bug: + Reports with a reproducible example and descriptive detailed information will likely receive fixes faster. + +- type: dropdown + id: architecture + attributes: + label: Architecture + description: What is your Hardware Architecture?. + options: + - x86_64 (Default) + - x86_32 (32Bit) + - ARM_64 (64Bit) + - ARM_32 (32Bit) + - AVR, Arduino, ESP32 + - RISC (RISC-V) + - Others (Unknown) + validations: + required: false + +- type: dropdown + id: os + attributes: + label: Operating System + description: What is your Operating System?. + options: + - Linux + - Windows + - Mac OSX + - Android + - BSD + - FreeDOS + - ReactOS + - Others (Unknown) + validations: + required: false + +- type: dropdown + id: disk + attributes: + label: Disk + description: What is your main Disk Storage?. + options: + - SSD (Solid, M2, MSATA, NVME) + - HDD (SATA, IDE, SCSI, Mechanical) + - USB (Flash, USB2, USB3) + - Diskless (Netboot, run from RAM) + - Others (Unknown) + validations: + required: false + +- type: dropdown + id: ram + attributes: + label: Memory + description: What is your total RAM Memory capacity?. + options: + - 1 Gigabyte + - 2 Gigabytes + - 4 Gigabytes + - 8 Gigabytes + - 16 Gigabytes + - 32 Gigabytes + - 64 Gigabytes + - 128 Gigabytes + - 256 Gigabytes + - 512 Gigabytes + - Less than 1 Gigabyte + - Others (Unknown) + validations: + required: false + +- type: dropdown + id: cores + attributes: + label: CPU Cores + description: What is your total CPU Cores count?. + options: + - 1 CPU Cores + - 2 CPU Cores + - 4 CPU Cores + - 8 CPU Cores + - 16 CPU Cores + - 32 CPU Cores + - 64 CPU Cores + - 128 CPU Cores + - 256 CPU Cores + - 512 CPU Cores + - Others (Unknown) + validations: + required: false + +- type: dropdown + id: internet + attributes: + label: Internet Connection + description: What is your Internet connection?. + options: + - Optical Fiber (very fast) + - DSL (aDSL, DSL, etc) + - Wifi (WLAN, Wireless) + - LAN (RJ45, Local, etc) + - Satellite (StarLink, etc) + - Mobile (4G, 3G, Edge, etc) + - Offline (No Internet) + - Others (Unknown) + validations: + required: false + +- type: dropdown + id: browser + attributes: + label: What is your web browser? + options: + - Chrome/Chromium + - Firefox/Firefox Fork + - Apple Safari + - Microsoft Edge + - KDE (Konqueror, Falkon, QtWebkit, etc) + - Microsoft Internet Explorer (Deprecated) + - Others (Unknown) + validations: + required: false + +- type: dropdown + id: device + attributes: + label: Device + description: What kind of computer is it?. + options: + - Desktop PC + - Server PC + - Mobile device (Smartphone, Smartwatch, Tablet) + - Docker/Qemu (Container) + - VirtualBox/Vagrant (Virtual Machine) + - Embedded/IOT + - Arduino Kit/ESP32 Kit + - Game Console (Playstation, XBOX, SteamDeck, Switch) + - SmartTV/SmartDisplay/Smartprojector + - Drone/Robot/Exoskeleton + - ASIC/FPGA/Crypto-mining hardware + - PLC/Industrial/heavy machine + - Point Of Sale/Kiosk/ATM + - Car/Self-Driving/On-Board Computer + - Electric scooter/Electric bike + - Satellite/MicroSatellite + - Military machine + - Others (Unknown) + validations: + required: false + +- type: textarea + id: what-happened + attributes: + label: What happened? + description: | + Use DETAILED DESCRIPTIVE information about the problem. + Here, you go into more details about your Bug report. This section can be a few paragraphs long. + placeholder: Bug reports with full repro code and detailed information will be fixed faster. + validations: + required: true + +- type: textarea + id: current-logs + attributes: + label: Current Standard Output Logs + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + placeholder: Bug reports with full repro code and detailed information will be fixed faster. + render: shell + +- type: textarea + id: expected-logs + attributes: + label: Expected Standard Output Logs + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + placeholder: Bug reports with full repro code and detailed information will be fixed faster. + render: shell + +- type: textarea + id: possible-solution + attributes: + label: Possible Solution + description: Propose a possible solution. + validations: + required: false + +- type: textarea + id: extra-info + attributes: + label: Additional Information + description: Any additional relevant information. + validations: + required: false + +- type: markdown + attributes: + value: | + - Thanks for your contributions!, your Bug report will receive feedback from the community soon... + - Please check whether the problem still exists in the devel branch, see [rebuilding the compiler](https://nim-lang.github.io/Nim/intern.html#rebuilding-the-compiler). + - Consider writing a PR targetting devel branch after filing this, see [contributing](https://nim-lang.github.io/Nim/contributing.html). + - If it's a pre-existing compiler bug, see [Debugging the compiler](https://nim-lang.github.io/Nim/intern.html#debugging-the-compiler) + which should give more context on a compiler crash. + - If it's a regression, you can help us by identifying which version introduced the bug, + see [Bisecting for regressions](https://nim-lang.github.io/Nim/intern.html#bisecting-for-regressions), + or at least try known past releases (eg `choosenim 1.2.0`). + - [Please, consider a Donation for the Nim project.](https://nim-lang.org/donate.html) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 6a9afe071..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Feature request -about: Do you want to suggest a new feature? Use this template. -title: '' -labels: ["Feature"] -assignees: '' - ---- - -<!--- -Notice there is now a separate repository for the detailed RFCs and proposals: -https://github.com/nim-lang/RFCs - -If you have a simple feature request, you can post it here using this template, -but bear in mind that adding new features to the language is currently a low priority. ---> - - -### Summary -<!--- Short summary of your proposed feature --> - - -### Description -<!--- Describe your solution, what problem does it fix? --> - - -### Alternatives -<!--- Are there any alternatives you've considered? --> - - -### Additional Information -<!--- For Example: -* A link to a project where the issue is relevant. -* A link to a related issue or discussion. ---> diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..55b4836fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,73 @@ +name: "Feature request" +description: "Create a new Feature Request. Do you want to suggest a new feature? Use this form." +title: "Think about the title, twice." +labels: ["unconfirmed"] +body: + +- type: markdown + attributes: + value: | + - Please provide a minimal code example that illustrates the basic idea behind your feature request. + Reports with full repro code and descriptive detailed information will likely receive feedback faster. + - There is a separate repository for the detailed RFCs and proposals: https://github.com/nim-lang/RFCs. + If you have a simple feature request, you can post it here using this form, + but bear in mind that adding new features to the language is currently a low priority. + +- type: textarea + id: summary + attributes: + label: Summary + description: | + Use DETAILED DESCRIPTIVE information about the feature request. + Here, you go into more details about your ideas. This section can be a few paragraphs long. + placeholder: Short summary of your proposed feature. + validations: + required: true + +- type: textarea + id: description + attributes: + label: Description + description: Describe your solution, what problem does it fix? + validations: + required: true + +- type: textarea + id: alternatives + attributes: + label: Alternatives + description: Are there any alternatives you've considered? + validations: + required: false + +- type: textarea + id: Examples + attributes: + label: Standard Output Examples + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + placeholder: Example code here. + render: shell + +- type: textarea + id: incompatibility + attributes: + label: Backwards Compatibility + description: If your Feature Request introduces backward-incompatible changes, describe them and propose how to deal with them. + validations: + required: false + +- type: textarea + id: links + attributes: + label: Links + description: Please copy and paste any relevant links to projects, issues, discussions, technical documentations, code samples, etc. + validations: + required: false + +- type: markdown + attributes: + value: | + - Thanks for your contributions!, your ideas will receive feedback from the community soon... + - **Remember to :star: Star the Nim project on GitHub!.** + - Consider writing a PR targetting devel branch after filing this, see [contributing](https://nim-lang.github.io/Nim/contributing.html). + - [Please, consider a Donation for the Nim project.](https://nim-lang.org/donate.html) |