Skip to content

Commit b197a2c

Browse files
diningPhilosopher64Prabhakar Kumar
diningPhilosopher64
authored and
Prabhakar Kumar
committed
Introduces GitHub issue templates.
1 parent 4a25d68 commit b197a2c

File tree

6 files changed

+118
-17
lines changed

6 files changed

+118
-17
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Copyright 2023 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/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/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: markdown
42+
attributes:
43+
value: |
44+
## Run the `troubleshooting.py` script and paste the output below.
45+
46+
```bash
47+
$ python ./troubleshooting/troubleshooting.py
48+
```
49+
If you are collecting logs using the MWI_LOG_FILE environment variable, we recommend you provide the variable when executing the troubleshooting script:
50+
```bash
51+
$ MWI_LOG_FILE="/tmp/log.file" python ./troubleshooting/troubleshooting.py
52+
```
53+
For more information about the `MWI_LOG_FILE` environment variable, see [Advanced-Usage.md](https://github.com/mathworks/matlab-proxy/blob/main/Advanced-Usage.md)
54+
For more information about the troubleshooting script, see [Troubleshooting](https://github.com/mathworks/matlab-proxy/tree/main/troubleshooting)
55+
56+
57+
- type: textarea
58+
id: troubleshooting-script-output
59+
attributes:
60+
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 2023 The MathWorks, Inc.
2+
3+
blank_issues_enabled: true
4+
contact_links:
5+
- name: Report a Security Vulnerability
6+
url: https://github.com/mathworks/matlab-proxy/security/policy
7+
about: Follow these steps.

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Copyright 2023 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/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+

‎Advanced-Usage.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Advanced Usage
2-
Copyright (c) 2020-2023 The MathWorks, Inc. All rights reserved.
32

43
This page lists some of the advanced manuevers that may be of specific interest to help configure the package for use in your environment.
54

@@ -96,3 +95,9 @@ If you add the `frame-ancestors` directive, the browser does not block the conte
9695
For more information about `Content-Security-Policy` header, check the [Mozilla developer docs for Content-Security-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy).
9796

9897
**NOTE**: Setting custom HTTP headers is an advanced operation, only use this functionality if you are familiar with HTTP headers.
98+
99+
----
100+
101+
Copyright 2020-2023 The MathWorks, Inc.
102+
103+
----

‎SECURITY.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Security
2-
Copyright (c) 2020-2022 The MathWorks, Inc. All rights reserved.
32

4-
----
53
**Table of Contents:**
64
- [Reporting Security Vulnerabilities](#reporting-security-vulnerabilities)
75
- [Security Features](#security-features)
@@ -204,4 +202,10 @@ You can use them to gain access to your server as described in the [Introduction
204202
* Never share access to your server
205203
Never share URLs from `matlab-proxy` with others. Doing so is equivalent to sharing your user account.
206204

207-
* System administrators who launch `matlab-proxy` for other users, must launch the proxy as the user for whom the server is intended.
205+
* System administrators who launch `matlab-proxy` for other users, must launch the proxy as the user for whom the server is intended.
206+
207+
----
208+
209+
Copyright 2020-2023 The MathWorks, Inc.
210+
211+
----

‎troubleshooting/README.md‎

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,30 @@
11
# Troubleshooting guide for MATLAB proxy
2-
Runs basic environment checks to determine if required dependencies are met or not.
3-
2+
Use the `troubleshooting.py` script to check your environment for required dependencies.
43

54
## Table of Contents
65
1. [Requirements](#requirements)
7-
2. [Script invocation](#script-invocation)
8-
3. [Collecting matlab-proxy logs](#collecting-matlab-proxy-logs)
6+
2. [Running the Script](#running-the-script)
7+
3. [Collecting Logs](#collecting-logs)
98

109
# Requirements
1110
* Python
1211

1312

14-
# Script invocation
13+
# Running the Script
1514
From the folder where this repository is cloned, you can run the following command to gather troubleshooting output:
16-
`python ./troubleshooting/troubleshooting.py`
17-
18-
# Collecting MATLAB proxy logs
19-
If you are logging MATLAB proxy information into a log file using the **MWI_LOG_FILE** environment variable when initializing the matlab-proxy-app, we recommend that you also provide the same environment variable when executing the troubleshooting script. This ensures that the script can detect and gather the relevant logs for analysis.
15+
```bash
16+
$ python ./troubleshooting/troubleshooting.py
17+
```
18+
# Collecting Logs
19+
If you collect matlab-proxy logs using the **MWI_LOG_FILE** environment variable, we recommend that you provide the same variable when executing the troubleshooting script. This allows the script to gather the relevant logs for analysis.
2020

2121
An example command to do that in linux would be:
22-
`MWI_LOG_FILE=/tmp/log.file python ./troubleshooting/troubleshooting.py`
22+
```bash
23+
$ MWI_LOG_FILE=/tmp/log.file python ./troubleshooting/troubleshooting.py
24+
```
2325

2426
----
2527

2628
Copyright 2021-2023 The MathWorks, Inc.
2729

2830
----
29-
30-
31-

0 commit comments

Comments
 (0)