diff --git a/.github/ISSUE_TEMPLATE/error-form.yml b/.github/ISSUE_TEMPLATE/error-form.yml new file mode 100644 index 000000000..83cee6610 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/error-form.yml @@ -0,0 +1,64 @@ +name: Issue with Madlib +description: File an issue +title: '' +labels: ["needs triage 💭"] +body: + - type: input + id: version + attributes: + label: Madlib version + description: What version of Madlib are you running? -- `madlib -v` + placeholder: Use `madlib -v` to indicate the version number + validations: + required: true + - type: dropdown + id: installation + attributes: + label: Installation + description: How is Madlib installed on your system? + options: + - Installed via `npm` + - Compiled locally + - Other + - type: textarea + id: context + attributes: + label: Context + description: | + What were you trying to do? + Tip: You can attach images by clicking this area to highlight it and then dragging files in. + - type: textarea + id: expectation + attributes: + label: Expectation + description: What did you expect to happen? + validations: + required: true + - type: textarea + id: behavior + attributes: + label: Behavior + description: What actually happened? + validations: + required: true + - type: textarea + id: logs + attributes: + label: Log output + description: Relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: dropdown + id: target + attributes: + label: Code Targets + description: Some issues are only present in some build targets. Please use the the `--target` flag to validate which targets are affected. + multiple: true + options: + - Node + - LLVM + - Browser + - type: textarea + attributes: + label: Environment + description: Please list any relevant details about your environment + placeholder: Operating System / node -v / clang -v diff --git a/.github/ISSUE_TEMPLATE/error-report.md b/.github/ISSUE_TEMPLATE/error-report.md index 9345e74cb..a50ea8829 100644 --- a/.github/ISSUE_TEMPLATE/error-report.md +++ b/.github/ISSUE_TEMPLATE/error-report.md @@ -1,30 +1,44 @@ --- name: Error Report -about: Create a report to help us improve ______ +about: Report an error case for Madlib title: '' -labels: '' +labels: needs triage 💭, bug 🦟 assignees: '' - --- -## Symptoms: + + +### Context + + + +### Expectation + + + +### Behavior + + + +### Target + +Some issues are only present in some build targets, please use the `--target` flag to validate what targets this issue affects. Which targets are affected of the following: + +1. Node +1. LLVM +1. Browser -1. What did you expect to happen? -2. What actually happened? +### Environment -## Reproduction instructions + -*Please fill in missing / incorrect details!* +1. Operating System +1. Node Version +1. How is Madlib installed on your system? -1. `stack build` -2. `stack run -- madlib-exe -i src -o dist -c madlib.json` -3. See error: -``` -Error: blah -``` +### Additional details -**Screenshots** -If applicable, add screenshots to help explain your problem. +If needed, please add any additional context, including screenshots to help explain your problem. -**Additional context** -Add any other context about the problem here.