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

Improve bug report and feature request templates #671

Merged
merged 1 commit into from
Jan 14, 2024
Merged

Improve bug report and feature request templates #671

merged 1 commit into from
Jan 14, 2024

Conversation

smultar
Copy link
Contributor

@smultar smultar commented Dec 31, 2023

Created a different variant of the bug report form, that supports a checklist and requirements before submitting. Should resolve #670 and make bug reporting a bit clearer.

@smultar
Copy link
Contributor Author

smultar commented Dec 31, 2023

I just now realized, that you also mentioned a feature request form, in #670. Let me know if you would like me to produce another copy for that as well.

@davidjerleke davidjerleke added the documentation Improvements or additions to documentation label Jan 3, 2024
@zaaakher
Copy link
Contributor

zaaakher commented Jan 6, 2024

@smultar wonderful work 👍

I think for the embla version field we should make it a text input rather than a dropdown. So that it can be timeless and we don't have to update it to keep up with the current version because most likely we'll forget about it. (unless there's a standardized checklist of things to do upon every new release/version)

@zaaakher
Copy link
Contributor

zaaakher commented Jan 6, 2024

@davidjerleke would it be better if CONTRIBUTING.md is moved to the root directory? so that it shows up as a tab in the repo page (see image below)
image

I think that'd make it easier to find. unless there's a good reason why it should stay inside .github

@zaaakher
Copy link
Contributor

zaaakher commented Jan 6, 2024

Did a little search and it seems to be recommended to place CONTRIBUTING.md in the root directory.

@davidjerleke if you approve and want to delegate it to me I can make a PR for relocating it.

@davidjerleke
Copy link
Owner

davidjerleke commented Jan 6, 2024

@zaaakher I think all three things you've mentioned are good input. Thank you for being so dedicated to help out and improve Embla.

Did a little search and it seems to be recommended to place CONTRIBUTING.md in the root directory.

@davidjerleke if you approve and want to delegate it to me I can make a PR for relocating it.

Yes that would be great thanks!


I also agree with this.


@smultar wonderful work 👍

I agree. Nicely done. Thanks!


I think for the embla version field we should make it a text input rather than a dropdown. So that it can be timeless and we don't have to update it to keep up with the current version because most likely we'll forget about it. (unless there's a standardized checklist of things to do upon every new release/version)

Yes let's make it a text field to avoid manual labour!


Thank you both for all the help!

@smultar
Copy link
Contributor Author

smultar commented Jan 6, 2024

@davidjerleke I'll make it an input field, give me a moment to make those changes.

@davidjerleke davidjerleke self-assigned this Jan 6, 2024
.vscode/settings.json Outdated Show resolved Hide resolved
@davidjerleke
Copy link
Owner

I just now realized, that you also mentioned a feature request form, in #670. Let me know if you would like me to produce another copy for that as well.

@smultar if you don’t mind, I would very much appreciate that!

@davidjerleke davidjerleke changed the title Bug Report Template Improve bug report and feature request templates Jan 9, 2024
@davidjerleke
Copy link
Owner

davidjerleke commented Jan 14, 2024

@smultar @zaaakher I've:

  • Removed the cSpell.words.
  • Corrected the previously corrupted git history?
  • Added a feature request template.
  • Made some finishing touches.

If you don't mind, and don't feel obligated to, I would appreciate if you could just skim both templates and see if you find anything strange. That would speed up the process of merging this. But I will do it eventually if you don't have time.

Regardless, thanks a lot for your efforts ⭐!

Best,
David

@zaaakher
Copy link
Contributor

zaaakher commented Jan 14, 2024

Additionally,

I recommend creating a config.yml file inside /.github/ISSUE_TEMPLATE that could contain the following:

blank_issues_enabled: false
contact_links:
  - name: Ask a question
    url: https://github.com/davidjerleke/embla-carousel/discussions
    about: Ask questions and discuss with other community members

Similar to this Which will show an additional option upon issue creation like this

@davidjerleke
Copy link
Owner

Additionally,

I recommend creating a config.yml file inside /.github/ISSUE_TEMPLATE that could contain the following:

blank_issues_enabled: false
contact_links:
  - name: Ask a question
    url: https://github.com/davidjerleke/embla-carousel/discussions
    about: Ask questions and discuss with other community members

Similar to this Which will show an additional option upon issue creation like this

This is definitely the way to go. Thank you for this valuable input 🤩.

Co-authored-by: Smultar <Jason@smultar.com>
Co-authored-by: Zakher Masri <46135573+zaaakher@users.noreply.github.com>
@davidjerleke davidjerleke merged commit 710312d into davidjerleke:master Jan 14, 2024
@davidjerleke davidjerleke added the resolved This issue is resolved label Jan 14, 2024
@davidjerleke
Copy link
Owner

Thanks a ton @smultar and @zaaakher 🥇!

@smultar
Copy link
Contributor Author

smultar commented Jan 14, 2024

I just woke up in my time zone. It's -22 degrees outside, send help, please.

In other news, it was a pleasure, I see that you closed this out, is there anything else I need to do?

@davidjerleke
Copy link
Owner

Hi @smultar ❄️,

No this has been merged. Thanks for your contribution! Feel free to contribute again 👍.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation resolved This issue is resolved
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add checklist to bug report and feature request templates
3 participants