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

Update issue templates #27

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: Bug Report
description: Report a bug or unexpected behavior you encountered.
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
When reporting a bug, please complete this template thoroughly to help us address the issue effectively!
- type: textarea
id: description-of-bug
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
id: reproduction-steps
attributes:
label: To reproduce
description: Steps to reproduce the behavior.
validations:
required: true

- type: textarea
id: expectation
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true

- type: textarea
id: library-version
attributes:
label: Library version
description: Library and dart version where the bug was found.
validations:
required: true

- type: textarea
id: platforms
attributes:
label: Platform information
description: Information about the platform where the bug was found.
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Share any additional context or information about the bug.

- type: multiple_choice
id: experience
attributes:
label: How experienced are you with this library?
description: This helps us understand where in the user journey this issue might arise.
options:
- label: Beginner - Just getting started with this library
- label: Intermediate - Familiar with the basics or have used it in a few projects
- label: Expert - Experienced and comfortable with using this library in complex projects

- type: checkboxes
id: terms
attributes:
label: Are you interested in working on a PR for this?
options:
- label: I want to work on this
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/2_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Feature Request
description: Suggest a new feature for Relic.
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
When suggesting a feature, please read this complete form and fill in all the fields to ensure we understand your idea thoroughly!

- type: textarea
id: problem-to-solve
attributes:
label: Problem to Solve
description: What problem are you trying to solve with this feature?
validations:
required: true

- type: textarea
id: proposal
attributes:
label: Proposal
description: What is your proposed solution? Add as much detail as possible, including code examples or references.
validations:
required: true

- type: textarea
id: use-case
attributes:
label: Use Case
description: How would this feature be used in a real-world scenario? Provide an example if possible.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives
description: Are there any alternative solutions or features you've considered? If so, what are they?
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Share any additional context or information about the feature.

- type: multiple_choice
id: experience
attributes:
label: How experienced are you with this library?
description: This helps us understand where in the user journey this issue might arise.
options:
- label: Beginner - Just getting started with this library
- label: Intermediate - Familiar with the basics or have used it in a few projects
- label: Expert - Experienced and comfortable with using this library in complex projects

- type: checkboxes
id: terms
attributes:
label: Are you interested in working on a PR for this?
options:
- label: I want to work on this
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
26 changes: 26 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Description
_Provide a detailed description of the changes in this PR, including what it changes or adds, and why it is necessary._

## Related Issues
_Link any related issues here. If this PR fixes an issue, use the following syntax to close it automatically:_
- (Closes/Fixes): #<issue_number>

## Pre-Launch Checklist
Please ensure that your PR meets the following requirements before submitting:

- [ ] This update focuses on a single feature or bug fix. (For multiple fixes, please submit separate PRs.)
- [ ] I have read and followed the [Dart Style Guide](https://dart.dev/guides/language/effective-dart/style) and formatted the code using [dart format](https://dart.dev/tools/dart-format).
- [ ] I have referenced at least one issue this PR fixes or is related to.
- [ ] I have updated/added relevant documentation (doc comments with `///`), ensuring consistency with existing project documentation.
- [ ] I have added new tests to verify the changes.
- [ ] All existing and new tests pass successfully.
- [ ] I have documented any breaking changes below.

## Breaking Changes
- [ ] Includes breaking changes.
- [ ] No breaking changes.

_If there are breaking changes, clearly outline them here to ensure they are included in the release notes:_

## Additional Notes
_Include any additional information or context about the PR here, if needed._
Loading