RFC: Code of Conduct and updated Issue/PR templates #1052
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1052 +/- ##
=======================================
Coverage 90.33% 90.33%
=======================================
Files 59 59
Lines 1728 1728
=======================================
Hits 1561 1561
Misses 167 167Continue to review full report at Codecov.
|
.github/ISSUE_TEMPLATE.md
Outdated
|
|
||
| **What is the expected behavior?** | ||
|
|
||
| **Which versions of react-virtualized, and which browser / OS are affected by this issue? Did this work in previous versions of React?** |
There was a problem hiding this comment.
https://github.com/bvaughn/react-virtualized/blob/master/package.json#L162 probably also want some info about react version as we support multiple?
There was a problem hiding this comment.
Maybe "previous versions of r-v?"
.github/ISSUE_TEMPLATE.md
Outdated
|
|
||
| **What is the current behavior?** | ||
|
|
||
| **If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem. Your bug will get fixed much faster if we can run your code and it doesn't have dependencies other than React. Paste the link to your JSFiddle (https://jsfiddle.net/Luktwrdm/) or CodeSandbox (https://codesandbox.io/s/new) example below:** |
There was a problem hiding this comment.
These are the react code boxes, we should probably replace this with the ones we already had for this project?
https://codesandbox.io/s/03qpzq1p9p?module=%2FExample.js
https://plnkr.co/edit/6syKo8cx3RfoO96hXFT1
.github/ISSUE_TEMPLATE.md
Outdated
|
|
||
| --> | ||
|
|
||
| **What is the current behavior?** |
There was a problem hiding this comment.
We should probably highlight the section splits with h3 or h2 to make a noticeable difference with the descriptions, thoughts?
.github/ISSUE_TEMPLATE.md
Outdated
| * Plnkr: https://plnkr.co/edit/6syKo8cx3RfoO96hXFT1 | ||
|
|
||
| # Requesting a Feature? | ||
| <!-- |
There was a problem hiding this comment.
Shall we just delete instead of comment?
There was a problem hiding this comment.
I'm not sure I understand the use of the comment tag
Even though these are markdown files, when you open a new issue- they're going to appear in plaintext. (See here for an example)
So the comment tag won't actually work, nor will any of the fancier formatting :)
There was a problem hiding this comment.
@bvaughn that's intentional. i think those are things we want people to think about, but text that we don't want showing up in the final issue that's opened, so if it's there as a comment we don't have to depend on people to delete the text. should keep the same intent of the original content without cluttering up issue descriptions.
There was a problem hiding this comment.
I see. I would expect people to delete the contents of the issue template (and replace with their own issue description, etc.)
It doesn't make much sense to leave the template content in the issue, I think.
There was a problem hiding this comment.
ok! happy to uncomment and just leave it there as guiding text
|
everyone's had some time to think this one over. are we feeling good about where these are at? |
.github/ISSUE_TEMPLATE.md
Outdated
|
|
||
| ### What is the current behavior? | ||
|
|
||
| If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem. Your bug will get fixed much faster if we can run your code and it doesn't have dependencies other than React and react-virtualized. Paste the link to your JSFiddle (https://codesandbox.io/s/03qpzq1p9p?module=%2FExample.js) or Plnkr (https://plnkr.co/edit/6syKo8cx3RfoO96hXFT1) example below: |
There was a problem hiding this comment.
jsfiddle, plnkr or codesandbox?
Can we keep it to codesandbox? its easiest for maintainers.
There was a problem hiding this comment.
👍 some of this was just a merge of the existing templates and the React templates, i'll pare it down to just codesandbox
.github/ISSUE_TEMPLATE.md
Outdated
| | Browser | | | ||
| | OS | | | ||
| | React | | | ||
| | react-virtualized | | |
|
Looks awesome! |
Here's a proposal for a Code of Conduct (with pieces of both the WeAllJS and Facebook templates), and PR/Issue templates (a combination of the existing content and the React templates).
Any feedback is welcome!
cc/ @bvaughn @diogofcunha