Update bug_report.yml
tugcekucukoglu
parent
972a85eb20
commit
33b3fbc947
|
|
@ -1,102 +1,168 @@
|
||||||
name: Bug report
|
name: Bug report
|
||||||
description: Create a report to help PrimeVue improve.
|
description: Create a report to help PrimeNG improve.
|
||||||
title: 'Component Name: Issue Title'
|
title: Issue Title
|
||||||
labels: 'Status: Needs Triage'
|
labels:
|
||||||
|
- 'Status: Needs Triage'
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
# yamllint disable rule:line-length
|
|
||||||
value: >
|
value: >
|
||||||
### There is no guarantee in receiving an immediate response in GitHub Issue Tracker, If you'd like to secure our response, you may consider *PrimeVue PRO Support* where support is provided within 4 business hours
|
## Overview
|
||||||
# yamllint enable rule:line-length
|
|
||||||
|
|
||||||
|
PrimeNG receives close to 2 million downloads per month. As any other popular OSS project, you may understand that the core team does not have the bandwidth to review each and every issue in detail in their daily routines. We have established strict guidelines for issue creation to ensure we can effectively address issues. It will help us prioritize and manage our workload efficiently.
|
||||||
|
|
||||||
|
|
||||||
|
Adhering to these guidelines, you help us maintain and improve the project more effectively. If you'd like to get our detailed attention, consider PrimeNG PRO Support instead, which provides support within one business day. Thank you for your cooperation and contributions!
|
||||||
|
|
||||||
|
|
||||||
|
## Issue Creation Guidelines
|
||||||
|
|
||||||
|
|
||||||
|
To help us assist you better, please follow these mandatory requirements when creating an issue:
|
||||||
|
|
||||||
|
|
||||||
|
**Important:** Our bot will automatically close issues that do not follow these guidelines.
|
||||||
|
|
||||||
|
|
||||||
|
### Reproducer
|
||||||
|
|
||||||
|
|
||||||
|
Provide a clear and concise executable example that reproduces the issue based on our StackBlitz template.
|
||||||
|
|
||||||
|
|
||||||
|
### PrimeNG Version
|
||||||
|
|
||||||
|
Ensure that you are using PrimeNG version v19. Issues related to other versions will not be reviewed as they are part of PrimeNG LTS, which has an internal ticket management system.
|
||||||
|
|
||||||
|
|
||||||
|
### Provide a Pull Request
|
||||||
|
|
||||||
|
We highly encourage contributions from the community! If you have the time and ability, consider submitting a pull request to address this issue. Here's how you can get started:
|
||||||
|
|
||||||
|
1. Fork the repository.
|
||||||
|
2. Create a new branch (`git checkout -b feature/YourFeatureName`).
|
||||||
|
3. Run "npm run dev" command to deploy the showcase locally using the monorepo.
|
||||||
|
4. Make your changes.
|
||||||
|
5. Commit your changes (`git commit -m 'Add some feature'`).
|
||||||
|
6. Push to the branch (`git push origin feature/YourFeatureName`).
|
||||||
|
7. Open a pull request.
|
||||||
|
|
||||||
|
### Reason for No PR
|
||||||
|
|
||||||
|
|
||||||
|
If you are unable to provide a PR, please explain why. Understanding the reasons can help us improve and assist you in contributing.
|
||||||
|
|
||||||
|
|
||||||
|
### Discussions and Questions
|
||||||
|
|
||||||
|
|
||||||
|
Please refrain from creating issue tickets for questions or support requests. Instead, use the GitHub Discussions or join the PrimeLand Discord server for assistance.
|
||||||
|
|
||||||
|
|
||||||
|
## New Issue Report
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: description
|
id: description
|
||||||
attributes:
|
attributes:
|
||||||
label: Describe the bug
|
label: Describe the bug
|
||||||
description: A clear and concise description of what the bug is.
|
description: A clear and concise description of what the report is about.
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: pull_request
|
||||||
|
attributes:
|
||||||
|
label: Pull Request Link
|
||||||
|
description: Link to your pull request.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: checkboxes
|
||||||
|
id: reason_for_no_pr
|
||||||
|
attributes:
|
||||||
|
label: Reason for not contributing a PR
|
||||||
|
options:
|
||||||
|
- label: Lack of time
|
||||||
|
- label: Unsure how to implement the fix/feature
|
||||||
|
- label: Difficulty understanding the codebase
|
||||||
|
- label: Other
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: pr_other
|
||||||
|
attributes:
|
||||||
|
label: Other Reason
|
||||||
|
description: >-
|
||||||
|
If your answer to the previous question is "Other", please explain the
|
||||||
|
reason.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
- type: input
|
- type: input
|
||||||
id: reproducer
|
id: reproducer
|
||||||
attributes:
|
attributes:
|
||||||
label: Reproducer
|
label: Reproducer
|
||||||
placeholder: https://stackblitz.com/edit/primevue-4-vite-issue-template
|
placeholder: 'https://stackblitz.com/github/primefaces/primeng-issue-template'
|
||||||
description: |
|
description: >-
|
||||||
Please fork one of the issue template
|
Issues **without** a StackBlitz example will be closed automatically.
|
||||||
[PrimeVue 4 Issue Template](https://stackblitz.com/edit/primevue-4-vite-issue-template)
|
Please fork one of the issue template [PrimeNG Issue
|
||||||
[PrimeVue 4 TypeScript Issue Template](https://stackblitz.com/edit/primevue-4-ts-vite-issue-template-csnodp)
|
Template](https://stackblitz.com/github/primefaces/primeng-issue-template?file=src%2Fapp%2Fapp.component.html)
|
||||||
[PrimeVue 3 Issue Template](https://stackblitz.com/edit/primevue-3-vite-issue-template)
|
and create a case demonstrating your bug report.
|
||||||
[PrimeVue 3 TypeScript Issue Template](https://stackblitz.com/edit/primevue-3-vite-ts-issue-template)
|
validations:
|
||||||
[PrimeVue Nuxt Issue Template](https://stackblitz.com/edit/primevue-nuxt-issue-template)
|
required: true
|
||||||
[PrimeVue 2 Issue Template](https://codesandbox.io/s/primevue-2-issue-template-dw7jd7)
|
- type: textarea
|
||||||
and create a case demonstrating your bug report. Issues **without** a Stackblitz have much less possibility to be reviewed.
|
id: environment
|
||||||
|
attributes:
|
||||||
|
label: Environment
|
||||||
|
description: Tell us about your environment.
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: input
|
- type: input
|
||||||
id: pr-version
|
id: pr-version
|
||||||
attributes:
|
attributes:
|
||||||
label: PrimeVue version
|
label: Angular version
|
||||||
placeholder: x.x.x
|
placeholder: x.x.x
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
id: vue-version
|
id: primeng-version
|
||||||
attributes:
|
attributes:
|
||||||
label: Vue version
|
label: PrimeNG version
|
||||||
multiple: false
|
description: >-
|
||||||
|
Only issues related to v19 are valid, previous versions are covered by
|
||||||
|
PrimeNG LTS service.
|
||||||
options:
|
options:
|
||||||
- 4.x
|
- v19
|
||||||
- 3.x
|
- v18 (LTS Only)
|
||||||
- 2.x
|
- v17 (LTS Only)
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: dropdown
|
- type: input
|
||||||
id: language
|
id: node-version
|
||||||
attributes:
|
attributes:
|
||||||
label: Language
|
label: Node version
|
||||||
multiple: false
|
placeholder: x.x.x
|
||||||
options:
|
|
||||||
- TypeScript
|
|
||||||
- ES5
|
|
||||||
- ES6
|
|
||||||
- ALL
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: false
|
||||||
- type: dropdown
|
|
||||||
id: engine
|
|
||||||
attributes:
|
|
||||||
label: Build / Runtime
|
|
||||||
multiple: false
|
|
||||||
options:
|
|
||||||
- Vue CLI App
|
|
||||||
- TypeScript
|
|
||||||
- Nuxt
|
|
||||||
- Vite
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: input
|
- type: input
|
||||||
id: browsers
|
id: browsers
|
||||||
attributes:
|
attributes:
|
||||||
label: Browser(s)
|
label: Browser(s)
|
||||||
description: List specific browser(s) the problem occurs on or leave blank if ALL browsers
|
description: >-
|
||||||
placeholder: >
|
List specific browser(s) the problem occurs on or leave blank if ALL
|
||||||
|
browsers
|
||||||
|
placeholder: |
|
||||||
e.g. Safari 15, iOS 15.4, Chrome 90
|
e.g. Safari 15, iOS 15.4, Chrome 90
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: reproduce-steps
|
id: reproduce-steps
|
||||||
attributes:
|
attributes:
|
||||||
label: Steps to reproduce the behavior
|
label: Steps to reproduce the behavior
|
||||||
description: A clear and concise description of how to make the issue happen.
|
description: A clear and concise description of how to make the issue happen.
|
||||||
placeholder: >
|
placeholder: |
|
||||||
1. Go to '...'
|
1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error
|
||||||
2. Click on '....'
|
|
||||||
3. Scroll down to '....'
|
|
||||||
4. See error
|
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: expected-behavior
|
id: expected-behavior
|
||||||
attributes:
|
attributes:
|
||||||
label: Expected behavior
|
label: Expected behavior
|
||||||
description: A clear and concise description of what you expected to happen.
|
description: A clear and concise description of what you expected to happen.
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: true
|
||||||
Loading…
Reference in New Issue