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

Update issue template #565

Merged
merged 3 commits into from
Dec 2, 2020
Merged

Update issue template #565

merged 3 commits into from
Dec 2, 2020

Conversation

pradeepnschrodinger
Copy link
Collaborator

@pradeepnschrodinger pradeepnschrodinger commented Nov 16, 2020

Let's update the issue template as per #489.

Note that this repo has had a single issue template, which'll be used whenever user tries to open up a new issue.
This is the legacy workflow, and it's defined in .github/ISSUE_TEMPLATE.md

The newer workflow, however, is to specify multiple templates and let the user choose whatever seems best.
eg (seen in react-virtualized):
image

For that, instead of modifying the existing ISSUE_TEMPLATE.md file, we create a .md file for each of the templates. This PR will be for having something like the "Bug Reports" template.

The only change within the contents are the codesandbox link. I specified a slightly modified version from the one mentioned in #489.

Ofc, we don't have to do all these right away. The main goal from #489 was to just update the codesandbox link. But since we're already touching the issue template, it might be best to discuss these now.

@pradeepnschrodinger pradeepnschrodinger changed the title Update issue templates Update issue template Nov 16, 2020
@@ -0,0 +1,37 @@
---
name: Issue Template
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We could rename this to Bug Reports, if it's clearer to the user. eg:
image

Copy link
Member

Choose a reason for hiding this comment

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

Updating to Bug Reports sounds good to me

---
name: Issue Template
about: Template for issues
title: ''
Copy link
Collaborator Author

@pradeepnschrodinger pradeepnschrodinger Nov 16, 2020

Choose a reason for hiding this comment

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

Not sure if we wanna specify title here. Maybe something like "[BUG]" ? I'm inclined towards leaving this blank though.


## Steps to Reproduce (for bugs)
<!--- Provide a link to a live example, or - -->
<!--- Fork the CodePen to reproduce https://codesandbox.io/s/fixed-data-table-example-3gd9x ->
Copy link
Collaborator Author

@pradeepnschrodinger pradeepnschrodinger Nov 16, 2020

Choose a reason for hiding this comment

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

Updated code sandbox link. As noted in the sandbox description, this was forked from https://codesandbox.io/s/react-playground-y6zof.

The sandbox shows usage of FDT's native row expansion feature.
Right now it contains various helper cells, uses fake data store, has minimal styling done through aphrodite, and uses react state and handlers for row expansion.

Tbh, I feel this might be more complicated than what a regular user might expect when creating a new issue. If so, we could probably change the example to show a minimalistic example using fake data store; or even keep 2 links, one for basic, and one for advanced?

Copy link
Member

Choose a reason for hiding this comment

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

I don't have a problem with making that change. Maybe we could have both a simple and an advanced sandbox example?


## Steps to Reproduce (for bugs)
<!--- Provide a link to a live example, or - -->
<!--- Fork the CodePen to reproduce https://codesandbox.io/s/fixed-data-table-example-3gd9x ->
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

nit: change CodePen to CodeSandBox

Copy link
Member

@wcjordan wcjordan left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Collaborator Author

@pradeepnschrodinger pradeepnschrodinger left a comment

Choose a reason for hiding this comment

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

@wcjordan , I'll wait for another LGTM for the new changes

Comment on lines +27 to +28
<!--- * Basic template: https://codesandbox.io/s/fixed-data-table-basic-example-cwds0 ->
<!--- * Advanced template: https://codesandbox.io/s/fixed-data-table-advanced-example-3gd9x ->
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Let's have a basic and an advanced example for the user's convenience.

@pradeepnschrodinger pradeepnschrodinger merged commit 46a5087 into master Dec 2, 2020
@pradeepnschrodinger pradeepnschrodinger deleted the update-issue-template branch December 2, 2020 05:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants