Codesandbox-client: Issue Template

Created on 9 Apr 2018  ·  7Comments  ·  Source: codesandbox/codesandbox-client

It would be nice to have an Issue Template. The main information I'm missing from issues currently is: CodeSandbox version (can be found in the bottom of the sidebar) and a sandbox in which the error can be reproduced. It would also be good to know if the error cannot be reproduced when you download the sandbox locally and run it.

❕ Help Wanted 🔰 Beginner Friendly

Most helpful comment

@CompuIves awesome idea!

I think it should look something like this:

Body

  1. Description of the problem
  2. How has this issue affected you? What are you trying to accomplish?

Link to sandbox: link (optional)

Your Environment

| Software | Name/Version|
| ---------------- | ---------- |
| Сodesandbox |
| Browser |
| Operating System |

For example:

I have some troubles...
I tried...

Link to sandbox: link (optional)

| Software | Name/Version|
| ---------------- | ---------- |
| Сodesandbox | PROD-1523365492
| Browser | Chrome/65.0.3325.181
| Operating System | Linux/4.15.15-1-ARCH

I think you can add something else😊

All 7 comments

Perhaps additional information such as browser, browser version, OS? I'm not sure of the architecture of code sandbox, but perhaps user OS makes a difference, such as when considering line endings.

That's a good one! Would be good to have indeed.

@CompuIves awesome idea!

I think it should look something like this:

Body

  1. Description of the problem
  2. How has this issue affected you? What are you trying to accomplish?

Link to sandbox: link (optional)

Your Environment

| Software | Name/Version|
| ---------------- | ---------- |
| Сodesandbox |
| Browser |
| Operating System |

For example:

I have some troubles...
I tried...

Link to sandbox: link (optional)

| Software | Name/Version|
| ---------------- | ---------- |
| Сodesandbox | PROD-1523365492
| Browser | Chrome/65.0.3325.181
| Operating System | Linux/4.15.15-1-ARCH

I think you can add something else😊

Wow, that's beautiful @Komar0ff, definitely what we need!

@Komar0ff Do you want to create a PR for this? As described here, it should be named ISSUE_TEMPLATE.md, and let's put it in the .github folder, alongside the pull request template.

@lbogdan okay, i can do it!

Thanks to @Komar0ff , we now have different templates for bugs / features / questions. Good job!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Haroenv picture Haroenv  ·  3Comments

CompuIves picture CompuIves  ·  3Comments

donavon picture donavon  ·  3Comments

supersonicclay picture supersonicclay  ·  3Comments

miukimiu picture miukimiu  ·  3Comments