Skip to content

Commit

Permalink
Add docs and scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
BingLingGroup committed Mar 11, 2020
1 parent f49c1e3 commit 369ab56
Show file tree
Hide file tree
Showing 17 changed files with 942 additions and 31 deletions.
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: 'Bug report'
about: 'Create a report to help us improve'
title: ''
labels: 'Status: Review Needed'
assignees: ''

---

**Make sure you have read the readme, searched and read the issues related to yours. Otherwise it will be considered as a duplicate which will be closed immediately.**

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Command line arguments you are using.
2. A complete copy of command line output of the delethon. You can use `Ctrl-A` and `Ctrl-C` to copy all of them. Use the following markdown code block syntax is recommended. Copy them into the place between \`\`\`.

```
```

3. etc.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem. But it is not recommended using screenshots to demonstrate the commandline output unless you think it really matters.

**Environment (please complete the following information):**

- OS: [e.g. windows]
- Python Version: [e.g. Python 3.7]
- Delethon Version: [e.g. 0.4.1-alpha/0.5.4-alpha Nuitka windows release]

**Additional context** (Optional)
Add any other context about the problem here.
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.zh-Hans.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: '问题反馈'
about: '报告问题'
title: ''
labels: 'Status: Review Needed'
assignees: ''

---

**确保你已经看过 readme,也搜索并阅读过和你遇到的情况相关的问题。否则会被认为是重复的并被立刻关闭。**

**描述问题**
清晰并准确地描述问题。

**复现问题**
复现问题的步骤:

1. 你使用的命令行参数。
2. 一份完整的delethon命令行输出。你可以使用`Ctrl-A``Ctrl-C`去复制所有输出。推荐使用以下的代码块markdown语法,将代码块复制到\`\`\`\`\`\`之间即可。

```
```

3. 等等

**期待的行为**
清晰并准确地描述你本想做的事情。

**截图**
合适的话可以提供用以描述问题的截图。但是不推荐用截图来展示命令行输出,除非你真的认为这很有必要。

**操作环境(请提供以下完整数据):**

- 操作系统: [譬如 windows]
- Python版本: [譬如 Python 3.7]
- Delethon版本: [譬如 0.4.1-alpha或0.5.4-alpha Nuitka windows发布版]

**额外信息**(可选)
任何其他的能描述问题的信息。
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: 'Feature request'
about: 'Suggest an idea for this project'
title: ''
labels: 'Status: Review Needed'
assignees: ''

---

**Make sure you have read the readme, searched and read the issues related to yours. Otherwise it will be considered as a duplicate which will be closed immediately.**

**Is your feature request related to a problem? Please describe.** (Optional)
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** (Optional)
A clear and concise description of any alternative solutions or features you've considered.

**Additional context** (Optional)
Add any other context or screenshots about the feature request here.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.zh-Hans.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: '功能请求'
about: '新功能建议'
title: ''
labels: 'Status: Review Needed'
assignees: ''

---

**确保你已经看过 readme,也搜索并阅读过和你遇到的情况相关的问题。否则会被认为是重复的并被立刻关闭。**

**描述与这个功能请求有关的某一问题**(可选)
清晰并准确地描述这个问题。

**描述你期待的解决方案**
清晰并准确地描述你的解决方案。

**描述你考虑过的替代方案**(可选)
清晰并准确地描述类似功能的替代方案。

**额外的信息**(可选)
任何其他的能描述功能请求的信息。
31 changes: 31 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## Changelog

[简体中文](docs/CHANGELOG.zh-Hans.md)

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## TOC

- [Unreleased](#unreleased)
- [Added](#addedunreleased)
- [Changed](#changedunreleased)
- [0.1.0-alpha - 2020-03-11](#010-alpha---2020-03-11)
- [Added](#added040-alpha)

Click up arrow to go back to TOC.

### [Unreleased]

### [0.1.0-alpha] - 2020-03-11

#### Added(0.1.0-alpha)

- Add basic messages deleting functions.

<escape><a href = "#TOC">&nbsp;&nbsp;</a></escape>

[Unreleased]: https://github.com/BingLingGroup/autosub/compare/0.1.0-alpha...HEAD
[0.1.0-alpha]: https://github.com/BingLingGroup/autosub/releases/tag/0.1.0-alpha
Loading

0 comments on commit 369ab56

Please sign in to comment.