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 template #2804

Merged
merged 6 commits into from Oct 24, 2019
Merged

Add issue template #2804

merged 6 commits into from Oct 24, 2019

Conversation

@rachael-phillips
Copy link
Contributor

rachael-phillips commented Aug 30, 2019

I would like to add an issue template for our contributors.

issue: #2788

I would like to add an issue template for our contributors.
@rachael-phillips rachael-phillips requested a review from redallen Aug 30, 2019
@redallen redallen changed the title Update issue templates Add issue template Aug 30, 2019
@@ -0,0 +1,17 @@
---
name: PatternFly issue template

This comment has been minimized.

Copy link
@tlabaj

tlabaj Aug 30, 2019

Contributor

is this block needed?

This comment has been minimized.

Copy link
@rachael-phillips

rachael-phillips Sep 3, 2019

Author Contributor

No, I don't think so.


---

### Describe the issue. What are the expected and unexpected behavior categories?

This comment has been minimized.

Copy link
@tlabaj

tlabaj Aug 30, 2019

Contributor
Suggested change
### Describe the issue. What are the expected and unexpected behavior categories?
### Describe the issue. Including the expected and unexpected behavior
assignees: ''

---

This comment has been minimized.

Copy link
@tlabaj

tlabaj Aug 30, 2019

Contributor

Can we also add a question "is there a workaround?"

This comment has been minimized.

Copy link
@rachael-phillips

rachael-phillips Sep 3, 2019

Author Contributor

Yes, and maybe we wrap that into @redallen 's question about it being blocking. What about "If this issue is a bug, Is this issue blocking you or is there a work around?" cc @dgutride

Copy link
Contributor

redallen left a comment

I suggest we go with something closer to what React has. I've replaced "React" with "PatternFly" below and am open to feedback.

**Do you want to request a *feature* or report a *bug*?**

**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 PatternFly and React. Paste the link to your JSFiddle (https://jsfiddle.net/Luktwrdm/) or CodeSandbox (https://codesandbox.io/s/new) example below:**

**What is the expected behavior?**

**Which versions of PatternFly, and which browser are affected by this issue? Did this work in previous versions of PatternFly?**

Then we could also add:

**If working on a Red Hat product, which product is this affecting and is there a workaround for now?**

### Would you consider this issue a bug or enhancement?

### What is your product and what release version are you targeting?

This comment has been minimized.

Copy link
@redallen

redallen Aug 30, 2019

Contributor

Could also ask if this is blocking product work.

This comment has been minimized.

Copy link
@rachael-phillips

rachael-phillips Sep 3, 2019

Author Contributor

What do you think about this feedback @tlabaj ?

This comment has been minimized.

Copy link
@tlabaj

tlabaj Sep 4, 2019

Contributor

I think the wording here is what the team agreed upon. This give us more insight into an actual timeline for when the feature is needed.
cc @LHinson


---

### Describe the issue. What are the expected and unexpected behavior categories?

This comment has been minimized.

Copy link
@redallen

redallen Aug 30, 2019

Contributor

I don't like this wording. As a dev, I'm not sure what a behaviour "category" is.


### Please provide the steps to reproduce so we can better understand and address the issue. Feel free to link CodePen or another tool.

### Would you consider this issue a bug or enhancement?

This comment has been minimized.

Copy link
@redallen

redallen Aug 30, 2019

Contributor

I think this question should be asked first and read like "Is this a bug or feature request?"

This comment has been minimized.

Copy link
@rachael-phillips

rachael-phillips Sep 3, 2019

Author Contributor

@redallen we chose this wording because we felt it was most helpful for users who may not know what a feature request is. cc @tlabaj @dgutride

This comment has been minimized.

Copy link
@tlabaj

tlabaj Sep 4, 2019

Contributor

Maybe "Is this a bug or an enhancement?"

I've updated the PatternFly issue template
Copy link
Contributor

redallen left a comment

Love it ❤️ .


### Describe the issue. What is the expected and unexpected behavior?

### Please provide the steps to reproduce so we can better understand and address the issue. Feel free to link CodePen or another tool.

This comment has been minimized.

Copy link
@jschuler

jschuler Sep 20, 2019

Collaborator

Would be good to provide a ready-made environment that already pulls in PF etc

This comment has been minimized.

Copy link
@redallen

redallen Sep 23, 2019

Contributor

This is on my to-do list, especially with the -org refactor. You can add a followup issue and assign me!

@@ -0,0 +1,11 @@
Please populate the PatternFly issue template so we can learn more about your needs.

This comment has been minimized.

Copy link
@redallen

redallen Oct 22, 2019

Contributor

This line needs to be commented. Also, please add this codesandbox link for people to easily reproduce issues: https://codesandbox.io/s/x2isc

This comment has been minimized.

Copy link
@rachael-phillips

rachael-phillips Oct 22, 2019

Author Contributor

What do you mean by it needs to be commented? It is just a general description of the template. I can add the link for sure.

This comment has been minimized.

Copy link
@redallen

redallen Oct 23, 2019

Contributor

I mean it needs to look like this:

<!-- Please populate the PatternFly issue template so we can learn more about your needs. Here's a codesandbox link you can reproduce your issue in: https://codesandbox.io/s/x2isc -->

The <!-- --> makes it a comment that won't appear as plain text inside the issue.

@tlabaj
tlabaj approved these changes Oct 24, 2019
Copy link
Contributor

tlabaj left a comment

LGTM

@tlabaj tlabaj merged commit 22b3a6d into master Oct 24, 2019
8 checks passed
8 checks passed
ci/circleci: build Your tests passed on CircleCI!
Details
ci/circleci: build_integration Your tests passed on CircleCI!
Details
ci/circleci: build_pf3_docs Your tests passed on CircleCI!
Details
ci/circleci: build_pf4_docs Your tests passed on CircleCI!
Details
ci/circleci: lint Your tests passed on CircleCI!
Details
ci/circleci: test_jest_other Your tests passed on CircleCI!
Details
ci/circleci: test_jest_pf4 Your tests passed on CircleCI!
Details
ci/circleci: upload_docs Your tests passed on CircleCI!
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.