Skip to content

Commit

Permalink
minor #2084 Configure ISSUE_TEMPLATE (smnandre)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
kbond committed Aug 20, 2024
2 parents 09cc7d0 + 56d4a4f commit cff1b26
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: '🐞 Bug Report'
about: Report a bug in existing features
title: ''
labels: 'bug'
assignees: ''

---
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: '🚀 Feature Request'
about: Suggest ideas for new features or enhancements
title: ''
labels: 'RFC'
assignees: ''

---
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/3-documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: '📖 Documentation'
about: Help us improve the documentation!
title: ''
labels: 'docs'
assignees: ''

---

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: 🛟 Support / help
url: https://symfony.com/support
about: Ask your questions about Symfony UX

0 comments on commit cff1b26

Please sign in to comment.