-
Notifications
You must be signed in to change notification settings - Fork 11.6k
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
[ISSUE #6673]Issue template enhancements #6674
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
# | ||
# Licensed to the Apache Software Foundation (ASF) under one or more | ||
# contributor license agreements. See the NOTICE file distributed with | ||
# this work for additional information regarding copyright ownership. | ||
# The ASF licenses this file to You under the Apache License, Version 2.0 | ||
# (the "License"); you may not use this file except in compliance with | ||
# the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
# | ||
|
||
name: Bug Report | ||
title: "[Bug] Bug title " | ||
description: Create a report to help us identify any unintended flaws, errors, or faults. | ||
labels: [ "type/bug" ] | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Before Creating the Bug Report | ||
options: | ||
- label: > | ||
I found a bug, not just asking a question, which should be created in [GitHub Discussions](https://github.com/apache/rocketmq/discussions). | ||
required: true | ||
- label: > | ||
I have searched the [GitHub Issues](https://github.com/apache/rocketmq/issues) and [GitHub Discussions](https://github.com/apache/rocketmq/discussions) of this repository and believe that this is not a duplicate. | ||
required: true | ||
- label: > | ||
I have confirmed that this bug belongs to the current repository, not other repositories of RocketMQ. | ||
required: true | ||
|
||
- type: dropdown | ||
attributes: | ||
label: Environment | ||
description: Describe the environment. | ||
options: | ||
- Linux | ||
- Mac | ||
- Windows | ||
- Other | ||
validations: | ||
required: true | ||
|
||
- type: dropdown | ||
attributes: | ||
label: RocketMQ version | ||
description: Describe the RocketMQ version. | ||
options: | ||
- develop | ||
- 5.1.x | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sometimes we need Git commit id rather than the version number? |
||
- 5.0.x | ||
- 4.9.x | ||
- Other | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: JDK Version | ||
description: Run or Compiler version. | ||
placeholder: > | ||
Compiler: (e.g., "Oracle JDK 11.0.17") | ||
OS: (e.g., "Ubuntu 20.04") | ||
Runtime (if different from JDK above): (e.g., "Oracle JRE 8u251") | ||
OS (if different from OS compiled on): (e.g., "Windows Server 2019") | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
attributes: | ||
label: Describe the Bug | ||
description: Describe what happened. | ||
placeholder: > | ||
A clear and concise description of what the bug is. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Steps to Reproduce | ||
description: Describe the steps to reproduce the bug here. | ||
placeholder: > | ||
If possible, provide a recipe for reproducing the error. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: What Did You Expect to See? | ||
description: You expect to see result. | ||
placeholder: > | ||
A clear and concise description of what you expected to see. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: What Did You See Instead? | ||
description: You instead to see result. | ||
placeholder: > | ||
A clear and concise description of what you saw instead. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional Context | ||
description: Additional context. | ||
placeholder: > | ||
Add any other context about the problem here. | ||
validations: | ||
required: false |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
name: Enhancement Request | ||
title: "[Enhancement] Enhancement title" | ||
description: Suggest an enhancement for this project | ||
labels: [ "type/enhancement" ] | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Before Creating the Enhancement Request | ||
description: > | ||
Most of issues should be classified as bug or feature request. An issue should be considered as an enhancement when it proposes improvements to | ||
existing functionality or user experience, without necessarily introducing new features or fixing existing bugs. | ||
options: | ||
- label: > | ||
I have confirmed that this should be classified as an enhancement rather than a bug/feature. | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Summary | ||
placeholder: > | ||
A clear and concise description of the enhancement you would like to see in the project. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Motivation | ||
placeholder: > | ||
Explain why you believe this enhancement is necessary, and how it benefits the project and community. | ||
Include any specific use cases that you have in mind. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Describe the Solution You'd Like | ||
placeholder: > | ||
Describe the enhancement you propose, detailing the change and implementation steps involved. | ||
If you have multiple solutions, please list them separately. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Describe Alternatives You've Considered | ||
placeholder: > | ||
List any alternative enhancements or implementations you have considered, and explain why they may not be as effective or appropriate. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional Context | ||
placeholder: > | ||
Add any relevant context, screenshots, prototypes, or other supplementary information to help illustrate the enhancement. | ||
validations: | ||
required: false |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
name: Feature Request | ||
title: "[Feature] New feature title" | ||
description: Suggest an idea for this project. | ||
labels: [ "type/new feature" ] | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Is Your Feature Request Related to a Problem? | ||
description: Please Describe It. | ||
placeholder: > | ||
A clear and concise description of what the problem is. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Describe the Solution You'd Like | ||
description: Describe how you solved it. | ||
placeholder: > | ||
A clear and concise description of what you want to happen. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Describe Alternatives You've Considered | ||
description: Describe your solution | ||
placeholder: > | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional Context | ||
description: Additional context. | ||
placeholder: > | ||
Add any other context about the problem here. | ||
validations: | ||
required: false |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sometimes we need to specify the version and branch of the operating system, such as Ubuntu 18.04. Would it be more appropriate to use a textarea here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If it needs to be specific to a certain Linux system, using a textarea would be more appropriate. My original idea was just to differentiate between major system types. I will modify it.