diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 796c3aa..1884734 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,14 +7,14 @@ assignees: '' --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +## Context and related problem + + -**Describe the solution you would like** -A clear and concise description of what you want to happen. +## Description of the feature + + -*If applicable, describe alternatives you've considered* -A clear and concise description of any alternative solutions or features you've considered. - -*If applicable, provide additional context* -Add any other context or screenshots about the feature request here. +## Acceptable alternatives + + diff --git a/.github/ISSUE_TEMPLATE/user_bug_report.md b/.github/ISSUE_TEMPLATE/user_bug_report.md new file mode 100644 index 0000000..7ef2cc2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/user_bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Report a bug you encountered in Graasp +title: 'πŸ› Bug report' +labels: bug +assignees: '' + +--- + + + +## Expected Behavior + + +## Current Behavior + + + + +## Steps to Reproduce + + + +## Context (Environment) + + + + + + +## Workaround + diff --git a/README.md b/README.md index 575c82d..9449e9f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,33 @@ # Graasp Feedback -This repository captures feature requests, bug reports, and user feedback from across the Graasp ecosystem. +This repository captures [πŸ’‘ feature requests](./.github/ISSUE_TEMPLATE/feature_request.md), [πŸ› bug reports](./.github/ISSUE_TEMPLATE/user_bug_report.md), and user feedback from across the Graasp ecosystem. +## For Graasp users + +### I encountered a problem. How should I report this problem? + +If you encountered a problem in Graasp, it would be very helpful to us if you could [fill an issue](https://github.com/graasp/graasp-feedback/issues/new?assignees=&labels=πŸ›%20bug&template=user_bug_report.md&title=). + +### I have a need or an idea. How can I ask for a new feature? + +If you need a new feature, or have a great idea, please, [fill a feature request](https://github.com/graasp/graasp-feedback/issues/new?assignees=&labels=πŸ’‘%20feature&template=feature_request.md&title=). + +--- + +## For Graasp developers + +### πŸ“š Documentation + +Documentation for Graasp is available on [graasp.github.io/docs/](https://graasp.github.io/docs/). + +### Management of the issues + +The issues of this repository is used to track feature requests and bug report from Graasp's users. To help with their management, issues should be labeled. + +| Label groups | Labels | +|--------------|-----------| +| Type | ![documentation](https://img.shields.io/github/labels/graasp/graasp-feedback/πŸ“š%20documentation?style=flat-square) ![feature](https://img.shields.io/github/labels/graasp/graasp-feedback/πŸ’‘%20feature?style=flat-square) ![bug](https://img.shields.io/github/labels/graasp/graasp-feedback/πŸ›%20bug?style=flat-square) | +| Platform | ![backend](https://img.shields.io/github/labels/graasp/graasp-feedback/🏭%20backend?style=flat-square) ![mobile](https://img.shields.io/github/labels/graasp/graasp-feedback/πŸ“±%20mobile?style=flat-square) ![web](https://img.shields.io/github/labels/graasp/graasp-feedback/πŸ•ΈοΈ%20web?style=flat-square) | +| Context | ![player](https://img.shields.io/github/labels/graasp/graasp-feedback/player?style=flat-square) ![library](https://img.shields.io/github/labels/graasp/graasp-feedback/library?style=flat-square) ![builder](https://img.shields.io/github/labels/graasp/graasp-feedback/builder?style=flat-square) ![analytics](https://img.shields.io/github/labels/graasp/graasp-feedback/analytics?style=flat-square) ![application](https://img.shields.io/github/labels/graasp/graasp-feedback/application?style=flat-square) | +| State | ![needs triage](https://img.shields.io/github/labels/graasp/graasp-feedback/πŸ”€%20needs%20triage?style=flat-square) ![on hold](https://img.shields.io/github/labels/graasp/graasp-feedback/βœ‹%20on%20hold?style=flat-square) ![in progress](https://img.shields.io/github/labels/graasp/graasp-feedback/πŸ”¨%20in%20progress?style=flat-square) ![needs information](https://img.shields.io/github/labels/graasp/graasp-feedback/❓%20needs%20information?style=flat-square) | +| Inactive | ![invalid](https://img.shields.io/github/labels/graasp/graasp-feedback/invalid?style=flat-square) ![wontfix](https://img.shields.io/github/labels/graasp/graasp-feedback/wontfix?style=flat-square) ![duplicate](https://img.shields.io/github/labels/graasp/graasp-feedback/duplicate?style=flat-square) |