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

Create ISSUE_TEMPLATE / config #1666

Closed
wants to merge 2 commits into from
Closed

Conversation

smnandre
Copy link
Collaborator

@smnandre smnandre commented Mar 29, 2024

Update: i now suggest we start with a issue type selector panel, to move on step by step and keep easy-to-fill bug reports / suggestions.

@carsonbot carsonbot added the Status: Needs Review Needs to be reviewed label Mar 29, 2024
- Icons
- Translator
- Twig Component
- Autre
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Autre -> Other :)

Should we add all components?

        - Autocomplete
        - Chartjs
        - Cropperjs
        - Dropzone
        - Icons
        - LazyImage
        - LiveComponent
        - Notify
        - React
        - StimulusBundle
        - Svelte
        - Swup
        - TogglePassword
        - Translator
        - Turbo
        - TwigComponent
        - Typed
        - Vue

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had the idea to select only the most frequent in support... as a big list is always something a bit frightening :|

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

haha yeah I get it! Although the list would probably not change that often and it could be a bit more directive / clear for the bug reporter (and thus bugfixer). At least we should change the Autre to Other or are you trying to sneak in little bits of french 😅

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hahah yes of course baguette...

I have really no strong opinion, not even sure it's better than "free textarea'... i think we should try something and iterate (and i'm not against starting with all of them :) )

i'm waiting the "staff" to give their opinion (when they have time, this has a -5000 prioriy like no others before 😅 )

@javiereguiluz
Copy link
Member

This looks like something useful to have. Is there anything else left to do before merging? Thanks!

@smnandre
Copy link
Collaborator Author

I think we need to discuss what information we want to get from this form ? Any feedback / advice ?

@smnandre
Copy link
Collaborator Author

I changed my mind

Well we have too many packages i'm not sure this is still a good idea (and carsonbot helps us to sort things)

packages

(dummy data but this gives a good idea of what i would look like)

Suggestion

💡 I think the best thing today would be a "issue selector panel" (and keep very free / simple forms for now for features and bugs)

Almost exactly the same as php-cs-fixer: https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/issues/new/choose

phpcs

So If you're ok to test 'll open a PR monday with the items i had in mind :)

cc @WebMamba @kbond @Kocal

@smnandre smnandre changed the title Create BUG_REPORT model Create ISSUE_TEMPLATE / config Aug 18, 2024
@Kocal
Copy link
Collaborator

Kocal commented Aug 18, 2024

That's would be great yet!
Do you plan to keep the select for the packages? It liked it a lot

@smnandre smnandre mentioned this pull request Aug 18, 2024
3 tasks
@smnandre
Copy link
Collaborator Author

Closing this one: replaced by #2084 for the first part / then we will deal form by form :)

@smnandre smnandre closed this Aug 18, 2024
kbond added a commit that referenced this pull request Aug 20, 2024
This PR was merged into the 2.x branch.

Discussion
----------

Configure ISSUE_TEMPLATE

This PR add an [issue template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates) selector for the repository.

It replaces #1666 (for the first part)

## Issue Template Selector

### Live Demo

I made an example repository: [https://github.com/smnandre/ux-issues](https://github.com/smnandre/ux-issues/issues/new/choose)

<img width="1169" alt="Capture d’écran 2024-08-18 à 23 34 08" src="https://github.com/user-attachments/assets/0ace3654-6958-464a-afed-d29505cabedd">

### Benefits

This selector has many benefits:
- [x] differenciate bug & features
- [x] add tags automatically
- [x] expose the symfony support page

### Plan

I'd like to release this **first step** asap..

And _then_ iterate on the different forms (bug report & feature request) because they can require long discussions and i'd like to be more agile on this :)

## Resources

### Github documentation

* [About issue and pull request templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)
* [Create an issue template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository)
* [Syntax for issue forms](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms) (next step)

### Inspirations / examples

* https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/issues/new/choose
* https://github.com/sebastianbergmann/phpunit/issues/new/choose
* https://github.com/guzzle/guzzle/issues/new/choose
* https://github.com/go-gitea/gitea/issues/new/choose
* https://github.com/angular/angular/issues/new/choose
* https://github.com/yarnpkg/berry/issues/new/choose
* https://github.com/ddev/ddev/issues/new/choose
* https://github.com/doctrine/orm/issues/new/choose

Commits
-------

56d4a4f Configure ISSUE_TEMPLATE
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Needs Review Needs to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants