Skip to content

Commit

Permalink
[ISSUE #91] Enable issue and PR templates (#92)
Browse files Browse the repository at this point in the history
* Copy templates from EventMesh

* Change branch name from `master` to `main`

* Temporarily set `approving_count` to 0 to allow committers to merge themselves PR
  • Loading branch information
Pil0tXia authored Apr 8, 2024
1 parent b65a406 commit 655c178
Show file tree
Hide file tree
Showing 8 changed files with 515 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .asf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ github:
strict: true
required_pull_request_reviews:
dismiss_stale_reviews: true
required_approving_review_count: 1
required_approving_review_count: 0 # Temporary 0 to allow committers to merge themselves PR
notifications:
commits: commits@eventmesh.apache.org
# Send all issue emails (new, closed, comments) to issues@
Expand Down
120 changes: 120 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
#
# 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/apache/eventmesh/issues?q=is%3Aissue)
first to see whether the same issue was reported already.
options:
- label: >
I had searched in the [issues](https://github.com/apache/eventmesh/issues?q=is%3Aissue) 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: EventMesh version
description: Describe the EventMesh version.
options:
- main
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 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.
render: Java
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 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_related.yml
Original file line number Diff line number Diff line change
@@ -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/apache/eventmesh/issues?q=is%3Aissue)
first to see whether the same issue was reported already.
options:
- label: >
I had searched in the [issues](https://github.com/apache/eventmesh/issues?q=is%3Aissue) 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 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement_request.yml
Original file line number Diff line number Diff line change
@@ -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/apache/eventmesh/issues?q=is%3Aissue)
first to see whether the same issue was reported already.
options:
- label: >
I had searched in the [issues](https://github.com/apache/eventmesh/issues?q=is%3Aissue) 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://github.com/apache/eventmesh/tree/develop/docs,
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!"
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -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/apache/eventmesh/issues?q=is%3Aissue)
first to see whether the same issue was reported already.
options:
- label: >
I had searched in the [issues](https://github.com/apache/eventmesh/issues?q=is%3Aissue) 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://github.com/apache/eventmesh/tree/develop/docs,
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!"
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -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/apache/eventmesh/issues?q=is%3Aissue)
first to see whether the same issue was reported already.
options:
- label: >
I had searched in the [issues](https://github.com/apache/eventmesh/issues?q=is%3Aissue) 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!"
Loading

0 comments on commit 655c178

Please sign in to comment.