Skip to content

Commit 94798c5

Browse files
diningPhilosopher64Prabhakar Kumar
authored and
Prabhakar Kumar
committed
Issue templates for jupyter-matlab-proxy
1 parent a873534 commit 94798c5

File tree

4 files changed

+107
-1
lines changed

4 files changed

+107
-1
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Copyright 2024 The MathWorks, Inc.
2+
3+
name: "🐞 Bug Report"
4+
title: "[Enter short description of bug.]"
5+
description: "Report a bug."
6+
labels: [bug, needs-triage]
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Before reporting a bug, see [Issues](https://github.com/mathworks/jupyter-matlab-proxy/issues) to check if an issue already exists for the bug you encountered. To request a feature or report a vulnerability, return to [Create an Issue](https://github.com/mathworks/jupyter-matlab-proxy/issues/new/choose).
12+
13+
- type: markdown
14+
attributes:
15+
value: |
16+
## Provide details about the bug:
17+
* What is the problem?
18+
* What behavior were you expecting?
19+
* What happened instead?
20+
* Include full errors, uncaught exceptions, stack traces, and relevant logs.
21+
* Provide a sequence of steps to reproduce the issue.
22+
* Suggest a fix, if possible.
23+
* Any additional information that might be relevant.
24+
25+
- type: textarea
26+
id: bug-summary
27+
attributes:
28+
label: Summary
29+
30+
- type: dropdown
31+
id: browsers
32+
attributes:
33+
label: Browser(s) used
34+
multiple: true
35+
options:
36+
- Chrome
37+
- Firefox
38+
- Safari
39+
- Microsoft Edge
40+
41+
- type: dropdown
42+
id: Feature-issue
43+
attributes:
44+
label: Issue found in
45+
multiple: true
46+
options:
47+
- MATLAB Kernel
48+
- MATLAB Desktop
49+
- Syntax Highlighting, Auto Indentation, Tab Completion
50+
- MAGIC Commands
51+
- Others
52+
53+
- type: markdown
54+
attributes:
55+
value: |
56+
## Run the `troubleshooting.py` script and paste the output below.
57+
58+
```bash
59+
$ python ./troubleshooting/troubleshooting.py
60+
```
61+
If you are collecting logs using the MWI_LOG_FILE environment variable, we recommend you provide the variable when executing the troubleshooting script:
62+
```bash
63+
$ MWI_LOG_FILE="/tmp/log.file" python ./troubleshooting/troubleshooting.py
64+
```
65+
For more information about the `MWI_LOG_FILE` environment variable, see [Advanced-Usage.md](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/Advanced-Usage.md)
66+
For more information about the troubleshooting script, see [Troubleshooting](https://github.com/mathworks/jupyter-matlab-proxy/tree/main/troubleshooting)
67+
68+
69+
- type: textarea
70+
id: troubleshooting-script-output
71+
attributes:
72+
label: Script output

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Copyright 2024 The MathWorks, Inc.
2+
3+
blank_issues_enabled: true
4+
contact_links:
5+
- name: Report a Security Vulnerability
6+
url: https://github.com/mathworks/jupyter-matlab-proxy/security/policy
7+
about: Follow these steps.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Copyright 2024 The MathWorks, Inc.
2+
3+
name: 🚀 Feature Request
4+
description: Suggest a feature for this project.
5+
title: "(short issue description)"
6+
labels: [feature-request, needs-triage]
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
To report a bug or security vulnerability, return to [Create an Issue](https://github.com/mathworks/jupyter-matlab-proxy/issues/new/choose).
12+
13+
- type: markdown
14+
attributes:
15+
value: |
16+
## Provide details of the feature you are proposing:
17+
* A brief description
18+
* What use case or challenge would this help you overcome? For example: “Currently, it’s too time-consuming/difficult to do…”
19+
* Suggestions for implementing the request: provide a prototype, sketch, reference etc.
20+
* Any additional information: details, stack traces, related issues, links for context, etc.
21+
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: Details of the feature
26+

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# MATLAB Integration _for Jupyter_
22

3-
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mathworks/jupyter-matlab-proxy/test-jupyter-matlab-proxy.yml?branch=main&logo=github)](https://github.com/mathworks/jupyter-matlab-proxy/actions) [![PyPI badge](https://img.shields.io/pypi/v/jupyter-matlab-proxy.svg?logo=pypi)](https://pypi.python.org/pypi/jupyter-matlab-proxy) [![codecov](https://codecov.io/gh/mathworks/jupyter-matlab-proxy/branch/main/graph/badge.svg?token=ZW3SESKCSS)](https://codecov.io/gh/mathworks/jupyter-matlab-proxy)
3+
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mathworks/jupyter-matlab-proxy/run-tests.yml?branch=main&logo=github)](https://github.com/mathworks/jupyter-matlab-proxy/actions) [![PyPI badge](https://img.shields.io/pypi/v/jupyter-matlab-proxy.svg?logo=pypi)](https://pypi.python.org/pypi/jupyter-matlab-proxy) [![codecov](https://codecov.io/gh/mathworks/jupyter-matlab-proxy/branch/main/graph/badge.svg?token=ZW3SESKCSS)](https://codecov.io/gh/mathworks/jupyter-matlab-proxy) [![Downloads](https://static.pepy.tech/personalized-badge/jupyter-matlab-proxy?period=month&units=international_system&left_color=grey&right_color=blue&left_text=PyPI%20downloads/month)](https://pepy.tech/project/jupyter-matlab-proxy)
4+
45

56

67
Run MATLAB® code in Jupyter® environments such as Jupyter notebooks, JupyterLab, and JupyterHub.

0 commit comments

Comments
 (0)