msb-public
/
hippo4j
mirror of https://github.com/longtai-cn/hippo4j
1
0
Code Issues Projects Releases Wiki Activity

Add some issue templates. (#1430)

Browse Source 
* add some issue templates.

* update develop guidelines link.
pull/1431/head
yanrongzhen 10 months ago committed by GitHub
parent a49a1b2fff
commit 57dfc54e6e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 464 additions and 66 deletions
Show Stats Download Patch File Download Diff File

27
.github/ISSUE_TEMPLATE/bug-report.md vendored
Unescape View File

@ -1,27 +0,0 @@
---
name: "BUG Report"
about: Submitting problem defects helps us to improve
---
## BUG Report
Before you start reporting errors, make sure you carefully review the following steps:
- Search for open and closed [GitHub ISSUE](https://github.com/opengoofy/hippo4j/issues)
- Read [Frequently asked questions](https://hippo4j.cn/community/faq)
Please answer these questions before submitting them. Thank you.
### Which Project did you use? Hippo4j config or Hippo4j server?
### Which version did you use?
### Expected behavior
### Actual behavior
### Cause analysis (if possible)
### Problem recurrence steps
### Sample code to reproduce the problem (for example, the GitHub Link)

112
.github/ISSUE_TEMPLATE/bug_report.yml vendored
Unescape View File

@ -0,0 +1,112 @@
#
# 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: If something isn't working as expected.
labels: [ "bug" ]
body:
- type: markdown
attributes:
value: |
For better global communication, Please write in English.
- type: checkboxes
attributes:
label: Search before asking
description: >
Please make sure to search in the [issues](https://github.com/opengoofy/hippo4j/issues)
first to see whether the same issue was reported already.
options:
- label: >
I had searched in the [issues](https://github.com/opengoofy/hippo4j/issues) and found
no similar issues.
required: true
- type: dropdown
attributes:
label: Environment
description: Describe the environment.
options:
- Mac
- Windows
- Linux
- Other
validations:
required: true
- type: dropdown
attributes:
label: Hippo4j version
description: Describe the Hippo4j version.
options:
- develop
- 1.5.0
- 1.4.3
- Other
validations:
required: true
- type: textarea
attributes:
label: What happened
description: Describe what happened.
placeholder: >
A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: How to reproduce
description: >
Describe the steps to reproduce the bug here.
placeholder: >
Please make sure you provide a reproducible step-by-step case of how to reproduce the problem
as minimally and precisely as possible.
validations:
required: true
- type: textarea
attributes:
label: Debug logs
description: Anything else we need to know?
placeholder: >
Add your debug logs here.
validations:
required: false
- type: checkboxes
attributes:
label: Are you willing to submit PR?
description: >
This is absolutely not required, but we are happy to guide you in the contribution process
especially if you already have a good understanding of how to implement the fix.
options:
- label: Yes I am willing to submit a PR!
- type: checkboxes
attributes:
label: Code of Conduct
description: >
The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it..
options:
- label: I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct) *
- type: markdown
attributes:
value: "Thanks for completing our form!"

68
.github/ISSUE_TEMPLATE/documentation_related.yml vendored
Unescape View File

@ -0,0 +1,68 @@
#
# 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: Documentation Related
title: "[Doc] Documentation Related "
description: I find some issues related to the documentation.
labels: [ "documentation" ]
body:
- type: markdown
attributes:
value: |
For better global communication, Please write in English.
- type: checkboxes
attributes:
label: Search before asking
description: >
Please make sure to search in the [issues](https://github.com/opengoofy/hippo4j/issues)
first to see whether the same issue was reported already.
options:
- label: >
I had searched in the [issues](https://github.com/opengoofy/hippo4j/issues) and found
no similar issues.
required: true
- type: textarea
attributes:
label: Documentation Related
description: Describe the suggestion about document.
placeholder: >
e.g There is a typo
validations:
required: true
- type: checkboxes
attributes:
label: Are you willing to submit PR?
description: >
This is absolutely not required, but we are happy to guide you in the contribution process
especially if you already have a good understanding of how to implement the fix.
options:
- label: Yes I am willing to submit a PR!
- type: checkboxes
attributes:
label: Code of Conduct
description: >
The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it..
options:
- label: I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct) *
- type: markdown
attributes:
value: "Thanks for completing our form!"

77
.github/ISSUE_TEMPLATE/enhancement_request.yml vendored
Unescape View File

@ -0,0 +1,77 @@
#
# 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: Enhancement Request
title: "[Enhancement] Enhancement title"
description: I want to suggest an enhancement for this project
labels: [ "enhancement" ]
body:
- type: markdown
attributes:
value: |
For better global communication, Please write in English.
- type: checkboxes
attributes:
label: Search before asking
description: >
Please make sure to search in the [issues](https://github.com/opengoofy/hippo4j/issues)
first to see whether the same issue was reported already.
options:
- label: >
I had searched in the [issues](https://github.com/opengoofy/hippo4j/issues) and found
no similar issues.
required: true
- type: textarea
attributes:
label: Enhancement Request
description: Describe the suggestion.
placeholder: >
First of all: Have you checked the docs https://hippo4j.cn/community/dev_convention/code,
or GitHub issues whether someone else has already reported your issue?
validations:
required: true
- type: textarea
attributes:
label: Describe the solution you'd like
description: Describe the suggestion.
placeholder: >
A clear and concise description of what you want to happen. Add any considered drawbacks.
validations:
required: true
- type: checkboxes
attributes:
label: Are you willing to submit PR?
description: >
This is absolutely not required, but we are happy to guide you in the contribution process
especially if you already have a good understanding of how to implement the fix.
options:
- label: Yes I am willing to submit a PR!
- type: checkboxes
attributes:
label: Code of Conduct
description: >
The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it..
options:
- label: I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct) *
- type: markdown
attributes:
value: "Thanks for completing our form!"

12
.github/ISSUE_TEMPLATE/feature-request.md vendored
Unescape View File

@ -1,12 +0,0 @@
---
name: "Demand advice"
about: Propose ideas and suggestions for this project
---
## Demand advice
Please answer these questions before submitting them. Thank you.
### Is your function request related to the problem?
### Describe the function you want

70
.github/ISSUE_TEMPLATE/feature_request.yml vendored
Unescape View File

@ -0,0 +1,70 @@
#
# 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: Feature Request
title: "[Feature] Feature title "
description: I want to suggest a feature for this project.
labels: [ "feature" ]
body:
- type: markdown
attributes:
value: |
For better global communication, Please write in English.
- type: checkboxes
attributes:
label: Search before asking
description: >
Please make sure to search in the [issues](https://github.com/opengoofy/hippo4j/issues)
first to see whether the same issue was reported already.
options:
- label: >
I had searched in the [issues](https://github.com/opengoofy/hippo4j/issues) and found
no similar issues.
required: true
- type: textarea
attributes:
label: Feature Request
description: Describe the feature.
placeholder: >
First of all: Have you checked the docs https://hippo4j.cn/community/dev_convention/code,
or GitHub issues whether someone else has already reported your issue?
Maybe the feature already exists?
validations:
required: true
- type: checkboxes
attributes:
label: Are you willing to submit PR?
description: >
This is absolutely not required, but we are happy to guide you in the contribution process
especially if you already have a good understanding of how to implement the fix.
options:
- label: Yes I am willing to submit a PR!
- type: checkboxes
attributes:
label: Code of Conduct
description: >
The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it..
options:
- label: I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct) *
- type: markdown
attributes:
value: "Thanks for completing our form!"

27
.github/ISSUE_TEMPLATE/question-report.md vendored
Unescape View File

@ -1,27 +0,0 @@
---
name: "Question"
about: Use questions that were not answered in the documentation or discussion
---
## Question
Before you begin to report problems, make sure you carefully review the following steps:
- Searches for open and closed [GitHub ISSUE](https://github.com/opengoofy/hippo4j/issues)
- Read [Frequently asked questions](https://hippo4j.cn/community/faq)
Please answer these questions before submitting them. Thank you.
### Which Project did you use? Hippo4j config or Hippo4j server?
### Which version did you use?
### Expected behavior
### Actual behavior
### Cause analysis (if possible)
### Problem recurrence steps
### Sample code to reproduce the problem (for example, the GitHub Link)

51
.github/ISSUE_TEMPLATE/question.yml vendored
Unescape View File

@ -0,0 +1,51 @@
#
# 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: Question
title: "[Question] Question title "
description: I have a question that isn't answered in docs or issue.
labels: [ "question" ]
body:
- type: markdown
attributes:
value: |
For better global communication, Please write in English.
- type: checkboxes
attributes:
label: Search before asking
description: >
Please make sure to search in the [issues](https://github.com/opengoofy/hippo4j/issues)
first to see whether the same issue was reported already.
options:
- label: >
I had searched in the [issues](https://github.com/opengoofy/hippo4j/issues) and found
no similar issues.
required: true
- type: textarea
attributes:
label: Question
description: Describe your question.
placeholder: >
Describe your question here :D
validations:
required: true
- type: markdown
attributes:
value: "Thanks for completing our form!"

86
.github/ISSUE_TEMPLATE/unit_test.yml vendored
Unescape View File

@ -0,0 +1,86 @@
#
# 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: Unit Test
title: "[Unit Test] Unit test title"
description: I want to do some unit tests for this project
labels: [ "testing" ]
body:
- type: markdown
attributes:
value: |
For better global communication, Please write in English.
- type: checkboxes
attributes:
label: Search before asking
description: >
Please make sure to search in the [issues](https://github.com/opengoofy/hippo4j/issues)
first to see whether the same issue was reported already.
options:
- label: >
I had searched in the [issues](https://github.com/opengoofy/hippo4j/issues) and found
no similar issues.
required: true
- type: checkboxes
attributes:
label: Read the unit testing guidelines
description: >
Read the [develop guidelines](https://hippo4j.cn/community/dev_convention/code) before writing unit test code.
options:
- label: >
I have read.
required: true
- type: textarea
attributes:
label: Unit test request
description: Describe the unit test.
placeholder: >
First of all: Have you checked the docs https://hippo4j.cn/community/category/贡献规约,
or GitHub issues whether someone else has already reported your issue?
Maybe the unit tests you want to do have already been done?
validations:
required: true
- type: textarea
attributes:
label: Describe the unit tests you want to do
description: Describe the unit test.
value: |
Module name:
Located at:
Task status: ×(unfinished) / √(finished)
| Task Status | Class | Type |
| :------: | :------ | :------ |
| × | xxxxxx | xxxxxx |
validations:
required: true
- type: checkboxes
attributes:
label: Are you willing to submit PR?
description: >
This is absolutely not required, but we are happy to guide you in the contribution process
especially if you already have a good understanding of how to implement the fix.
options:
- label: Yes I am willing to submit a PR!
- type: markdown
attributes:
value: "Thanks for completing our form!"
Write Preview
Loading…
Cancel
Save