search

davidjerleke / embla-carousel

A lightweight carousel library with fluid motion and great swipe precision.
https://www.embla-carousel.com
MIT License
5.39k stars 166 forks source link

Improve bug report and feature request templates #671

Closed smultar closed 5 months ago

smultar commented 6 months ago

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 commented 6 months ago

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.

zaaakher commented 5 months ago

@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 commented 5 months ago

@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 commented 5 months ago

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 commented 5 months ago

@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 commented 5 months ago

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

davidjerleke commented 5 months ago

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 commented 5 months ago

@smultar @zaaakher I've:

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 commented 5 months ago

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 commented 5 months ago

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 🤩.

davidjerleke commented 5 months ago

Thanks a ton @smultar and @zaaakher 🥇!

smultar commented 5 months ago

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 commented 5 months ago

Hi @smultar ❄️,

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