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 form template #799

Merged
merged 2 commits into from
Dec 4, 2024
Merged

Add issue form template #799

merged 2 commits into from
Dec 4, 2024

Conversation

joshhanley
Copy link
Member

This PR adds an issue form template instead of just the single text box to add more structure for people reporting issues.

Screenshot 2024-12-03 at 9 46 57 AM Screenshot 2024-12-03 at 9 47 25 AM

@joshhanley
Copy link
Member Author

@jeffchown would love your thoughts on this if you get a chance 🙂

@joshhanley joshhanley changed the title Add issue template Add issue form template Dec 3, 2024
@jeffchown
Copy link

@joshhanley Looks good! It should definitely help structure both people's thinking when they are posting an issue, and the actual format of the issue report.

One thing I think should be added (that I forgot last time), is a bullet point at the top of the list re: ...before posting an issue, please: is:

  • make sure you have thoroughly searched the Issues and Discussions to make sure your question/issue has not already been answered

Even though you mention duplicates will be closed, that note is near the bottom and I think there is definitely an increase in duplicate issues/discussions being posted - hence my suggestion above.

And, re: the bullet point The code snippets contain unrelated code such as left-over Blade variables, I would add to it so it reads The code snippets contain unrelated code and/or external dependencies such as left-over Blade variables

If I think of anything else, I'll let you know. Have a great night!

@joshhanley
Copy link
Member Author

joshhanley commented Dec 3, 2024

@jeffchown legend, thanks! I've updated both of them. I changed the second one to "...left-over Blade variables or Models" too 😁

@jeffchown
Copy link

@joshhanley Might be a good idea to add some boilerplate to the New Discussion/Feature Request as well. A few new posts in there already today that could have benefited from a simple search of Issues/Discussions for previous duplicate posts.

@joshhanley
Copy link
Member Author

@jeffchown thanks! Yep and possibly "are you submitting a feature request" checkbox, as I've noticed quite a few questions being added as feature requests when they should have been issues 😬

I'll have a look at that later and add a separate PR for discussion templates if this one gets merged.

@ju5t
Copy link

ju5t commented Dec 4, 2024

I like it!

@calebporzio calebporzio merged commit 83e0304 into main Dec 4, 2024
@joshhanley joshhanley deleted the josh/add-issue-template branch December 4, 2024 23:27
@jeffchown
Copy link

@joshhanley Looks like the new template was used for #816 - love how clean the resulting issue post was! 👍

@jeffchown
Copy link

@joshhanley Could you edit the bullet point?:
Make sure you have thoroughly searched the Issues and Discussions to make sure your question/issue has not already been answered

changing it to:

Make sure you have thoroughly searched **all open and closed Issues and Discussions** to make sure your question/issue has not already been answered

And move it to the top of that bullet list? I think the issues/discussions are populated enough by now that there are quite a few answers out there already and more people need to perform more thorough searches before opening new issues.

@joshhanley
Copy link
Member Author

@jeffchown yeah seems like it's working well! I've updated the wording, but left it at the bottom for now. If need be I think we can pull it out of the bullet list and make it the first sentence on it's own.

@jeffchown
Copy link

@joshhanley OK. I bet you end up pulling it out on its own sooner than later ;)

@jeffchown
Copy link

@joshhanley Could you please add a bolded sub-bullet to the first one re: 'Make sure you have followed each step...'?:

  • Don't forget, the Tailwind CSS Forms plugin (tailwindcss/forms) is not compatible with Flux

@joshhanley
Copy link
Member Author

@jeffchown yep, I've actually got this on my list for Monday to do a deep dive to see if we can make Flux compatible with it, as this is going to keep coming up. If I can't get them to work nicely, then I will add that in.

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.

4 participants