Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add issue templates, reference codesandbox starters #16

Merged
merged 19 commits into from
Nov 17, 2021

Conversation

ChristianMurphy
Copy link
Member

Issue forms give a more structured flow to filling out bug reports and
feature requests.
Ensuring that information essential to helping resolve issues is
provided mostly upfront, to avoid unnecessary confusion and frustration
for both the reporters and maintainers during triage.

All of the information required in the form was previously required be
the issue template, but could be accidentally erased.

There are also additional optional fields around runtime, package
manager, operating system, and build tools, which are common follow up
questions during triage.

this also adds an optional, but much appreciated, field for a runnable
sandbox to demonstrate issues. Along with some starter templates for
codesandbox.

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms

Issue forms give a more structured flow to filling out bug reports and
feature requests.
Ensuring that information essential to helping resolve issues is
provided mostly upfront, to avoid unnecessary confusion and frustration
for both the reporters and maintainers during triage.

All of the information required in the form was previously required be
the issue template, but could be accidentally erased.

There are also additional optional fields around runtime, package
manager, operating system, and build tools, which are common follow up
questions during triage.

this also adds an optional, but much appreciated, field for a runnable
sandbox to demonstrate issues. Along with some starter templates for
codesandbox.

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms
@ChristianMurphy ChristianMurphy requested review from a team November 16, 2021 17:31
@ChristianMurphy
Copy link
Member Author

/cc @remcohaszing

.github/ISSUE_TEMPLATE/1-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/1-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/1-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/1-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/1-bug.yml Show resolved Hide resolved
ChristianMurphy and others added 6 commits November 16, 2021 11:00
Co-authored-by: Titus <tituswormer@gmail.com>
Co-authored-by: Titus <tituswormer@gmail.com>
Co-authored-by: Titus <tituswormer@gmail.com>
Co-authored-by: Titus <tituswormer@gmail.com>
Co-authored-by: Titus <tituswormer@gmail.com>
Copy link
Member

@wooorm wooorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fast refresh doesn’t seem to work with Next.js, should that be made possible (probably by having another page in between the content and the app)?

On that page, add something like:

// ⚠️ Important! Please make sure the dependencies are up to date.
// You can refresh them in the Dependencies section (left-bottom on CodeSandbox)

@ChristianMurphy

This comment has been minimized.

@wooorm

This comment has been minimized.

@wooorm
Copy link
Member

wooorm commented Nov 17, 2021

Care to add a Node.js example? Here’s roughly what I was thinking: https://codesandbox.io/s/gracious-fermi-pzich?file=/index.js. (p.s: for some reason it still thinks there’s a src/index.js, which I moved to index.js, and I’m not sure where that’s configured?)

Co-authored-by: Titus Wormer <tituswormer@gmail.com>
@ChristianMurphy
Copy link
Member Author

Care to add a Node.js example? Here’s roughly what I was thinking: https://codesandbox.io/s/gracious-fermi-pzich?file=/index.js.

Sure! Added in 0776279

Copy link
Member

@wooorm wooorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

last nit, perfect otherwise!

sandbox-templates/mdx-evaulate-node/index.js Outdated Show resolved Hide resolved
Co-authored-by: Titus <tituswormer@gmail.com>
@wooorm wooorm changed the title migrate issue templates to issue forms Add issue templates, reference codesandbox starters Nov 17, 2021
@wooorm wooorm merged commit 9cc95dd into mdx-js:master Nov 17, 2021
@wooorm
Copy link
Member

wooorm commented Nov 17, 2021

Thanks so much!!

@ChristianMurphy ChristianMurphy deleted the issue-forms branch November 17, 2021 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants