summary refs log tree commit diff stats
path: root/.github/ISSUE_TEMPLATE/bug_report.yml
blob: 01451386505034fa7805290d328de02df56202d9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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: textarea
  id: description
  attributes:
    label: Description
    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 reproducible code and detailed information will be fixed faster.
  validations:
    required: true
    
- type: textarea
  id: nim-version
  attributes:
    label: Nim Version
    description: Copy and paste the output of `nim -v` on the command line. For development versions, make sure to include the commit hash.
  validations:
    required: true

- type: textarea
  id: current-logs
  attributes:
    label: Current Output
    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 reproducible code and detailed information will be fixed faster.
    render: text

- type: textarea
  id: expected-logs
  attributes:
    label: Expected Output
    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 reproducible code and detailed information will be fixed faster.
    render: text

- 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 (e.g. `choosenim 2.0.0`). The Nim repo also supports online bisecting
        via making a comment, which contains a code block starting by `!nim c`, `!nim js` etc. , see [nimrun-action](https://github.com/juancarlospaco/nimrun-action).
      - [Please, consider a Donation for the Nim project.](https://nim-lang.org/donate.html)