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

add issue template #1700

Merged
merged 1 commit into from
Jan 26, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/wechaty-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
name: Wechaty Bug report
about: Create a bug report for a bug you found in wechaty

---

> Important:Please file the issue follow the template, or we won't help you to solve the problem.


## 0. Report Issue Guide

1. Please run the following command and check whether the problem has been fixed:
```
rm -rf package-lock.json
rm -rf node_modules
npm install
```

2. Please search in [FAQ List](https://docs.chatie.io/faq) first, and make sure your problem has not been solved before.

3. Please search in the issue first, and make sure your problem had not been reported before

## 1. Versions
- What is your wechaty version?
Answer:

- Which puppet are you using for wechaty? (padchat/puppeteer/padpro/...)
Answer:

- What is your wechaty-puppet-XXX(padchat/puppeteer/) version?
Answer:

- What is your node version? (run `node --version`)
Answer:

- What os are you using
Answer:

## 2. Describe the bug
Give a clear and concise description of what the bug is.

## 3. To Reproduce
This part is very important: if you can not provide any reproduce steps, then the problem will be very hard to be recognized.

Steps to reproduce the behavior:
1. run '...'
2. ...
3. ...

## 4. Expected behavior
Give a clear and concise description of what you expected to happen.

## 5. Actual behavior
If applicable, add screenshots to help explain your problem. But do not paste log screenshots here.


## 6. Full Output Logs
Set env `WECHATY_LOG=silly` in order to set log level to silly, then we can get the full log (If you dosen't set log env, log level is info as default, we cannot get the full log)

**We need full log instead of log screenshot or log fragments!**

<details>
<summary>
Show Logs
</summary>

```shell
$ WECHATY_LOG=silly node yourbot.js

Question: Paste your FULL(DO NOT ONLY PROVIDE FRAGMENTS) log messages
Answer:

```

</details>

## 7. Additional context
Add any other context about the problem here.

[bug]
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/wechaty-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: wechaty Feature request
about: Suggest a feature for wechaty

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**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.

[enhancement]
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/wechaty-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: wechaty Question
about: The issue tracker is not for questions. Please ask questions on https://stackoverflow.com/questions/tagged/wechaty

---

🚨 The issue tracker is not for questions 🚨

If you have a question, please ask it on https://stackoverflow.com/questions/tagged/wechaty

[question]