Skip to content

Commit

Permalink
[ISSUE #425] Using templates to encourage useful issues and PRs
Browse files Browse the repository at this point in the history
  • Loading branch information
SteveYurongSu committed Jul 9, 2021
1 parent de478dc commit cc0eb0b
Show file tree
Hide file tree
Showing 6 changed files with 183 additions and 1 deletion.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: 🐛 Bug Report
about: If something isn't working as expected.
labels: 'bug'
---

## Bug Report

### Describe the bug
<!--
A clear and concise description of what the bug is.
-->

### Environment

- OS: [e.g. Ubuntu 21.04 LTS]
- EventMesh version(s): [e.g. 1.2.0]
- RocketMQ version(s): [e.g. 4.7.1]
- ...

### Steps to reproduce
<!--
Describe the steps to reproduce the bug here.
-->

### Expected behavior
<!--
A clear and concise description of what you expected to happen.
-->

### Debug logs
<!--
Add your debug logs here.
-->

<details>
<summary>Click to expand</summary>

```
replace this line with your debug logs
```
</details>
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_related.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: ✏️ Documentation Related
about: I find some issues related to the documentation.
labels: 'doc'
---

## Documentation Related

<!--
Describe the issues here :D
-->
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: ✨ Enhancement Request
about: I want to suggest an enhancement for this project (and may want to implement it 🙂)!
labels: 'enhancement'
---

## Enhancement Request

<!--
First of all: Have you checked the docs https://github.com/apache/incubator-eventmesh/tree/develop/docs,
or GitHub issues whether someone else has already reported your issue?
-->

### Is your enhancement request related to a problem? Please describe

<!--
A clear and concise description of what the enhancement is.
-->

### Describe the solution you'd like

<!--
A clear and concise description of what you want to happen. Add any considered drawbacks.
-->

### Describe alternatives you've considered

<!--
A clear and concise description of any alternative solutions or features you've considered.
-->

### Additional context

<!--
Add any other context or screenshots about the enhancement request here.
-->
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: 🚀 Feature Request
about: I want to suggest a feature for this project (and may want to implement it 🙂)!
labels: 'feature'
---

## Feature Request

<!--
First of all: Have you checked the docs https://github.com/apache/incubator-eventmesh/tree/develop/docs,
or GitHub issues whether someone else has already reported your issue?
Maybe the feature already exists?
-->

### Is your feature request related to a problem? Please describe

<!--
A clear and concise description of what the problem is.
-->

### Describe the solution you'd like

<!--
A clear and concise description of what you want to happen. Add any considered drawbacks.
-->

### Describe alternatives you've considered

<!--
A clear and concise description of any alternative solutions or features you've considered.
-->

### Additional context

<!--
Add any other context or screenshots about the feature request here.
-->
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: 🤔 Question
about: I have a question that isn't answered in docs or discussions.
labels: 'question'
---

## Question

<!--
Describe your question here :D
-->
47 changes: 46 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1 +1,46 @@
#TBD
<!--
### Contribution Checklist
- Name the pull request in the form "[ISSUE #XXXX] Title of the pull request",
where *XXXX* should be replaced by the actual issue number.
Skip *[ISSUE #XXXX]* if there is no associated github issue for this pull request.
- Fill out the template below to describe the changes contributed by the pull request.
That will give reviewers the context they need to do the review.
- Each pull request should address only one issue.
Please do not mix up code from multiple issues.
- Each commit in the pull request should have a meaningful commit message.
- Once all items of the checklist are addressed, remove the above text and this checklist,
leaving only the filled out template below.
(The sections below can be removed for hotfixes of typos)
-->

<!--
(If this PR fixes a GitHub issue, please add `Fixes ISSUE#<XXX>`.)
-->

Fixes ISSUE#<XXXX>.

### Motivation

*Explain the content here.*
*Explain why you want to make the changes and what problem you're trying to solve.*



### Modifications

*Describe the modifications you've done.*



### Documentation

- Does this pull request introduce a new feature? (yes / no)
- If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
- If a feature is not applicable for documentation, explain why?
- If a feature is not documented yet in this PR, please create a followup issue for adding the documentation

0 comments on commit cc0eb0b

Please sign in to comment.