diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..5d454e8f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Create a bug report to help us improve +title: 'Bug: Something went wrong' +labels: bug +assignees: '' + +--- + +**描述问题:** + +A clear and concise description of what the bug is. + +**如何复现?** + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**期望的结果** + +A clear and concise description of what you expected to happen. + +**环境信息:** + + - OS: [e.g. Linux] + - Python Version: [e.g. 3.8] + - Nonebot Version [e.g. 2.0.0] + +**截图** + +If applicable, add screenshots to help explain your problem. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..045a2e25 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: 'Feature: Something you want' +labels: enhancement +assignees: '' + +--- + +**是否在使用中遇到某些问题而需要新的特性?请描述:** + +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**描述你所需要的特性:** + +A clear and concise description of what you want to happen. diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml new file mode 100644 index 00000000..fcca4ea8 --- /dev/null +++ b/.github/release-drafter.yml @@ -0,0 +1,31 @@ +name-template: 'v$RESOLVED_VERSION 🌈' +tag-template: 'v$RESOLVED_VERSION' +categories: + - title: '🚀 Features' + labels: + - 'feature' + - 'enhancement' + - title: '🐛 Bug Fixes' + labels: + - 'fix' + - 'bugfix' + - 'bug' + - title: '🧰 Maintenance' + label: 'chore' +change-template: '- $TITLE @$AUTHOR (#$NUMBER)' +change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks. +version-resolver: + major: + labels: + - 'major' + minor: + labels: + - 'minor' + patch: + labels: + - 'patch' + default: patch +template: | + ## Changes + + $CHANGES diff --git a/.github/workflows/release-draft.yml b/.github/workflows/release-draft.yml new file mode 100644 index 00000000..17fdb961 --- /dev/null +++ b/.github/workflows/release-draft.yml @@ -0,0 +1,14 @@ +name: Release Drafter + +on: + push: + branches: + - master + +jobs: + update_release_draft: + runs-on: ubuntu-latest + steps: + - uses: release-drafter/release-drafter@v5 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/docs/api/README.md b/docs/api/README.md index dcfb548c..710d44bd 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -4,46 +4,46 @@ * **模块索引** - * [nonebot](nonebot.html) + * [nonebot](nonebot.md) - * [nonebot.config](config.html) + * [nonebot.config](config.md) - * [nonebot.plugin](plugin.html) + * [nonebot.plugin](plugin.md) - * [nonebot.matcher](matcher.html) + * [nonebot.matcher](matcher.md) - * [nonebot.rule](rule.html) + * [nonebot.rule](rule.md) - * [nonebot.permission](permission.html) + * [nonebot.permission](permission.md) - * [nonebot.sched](sched.html) + * [nonebot.sched](sched.md) - * [nonebot.log](log.html) + * [nonebot.log](log.md) - * [nonebot.utils](utils.html) + * [nonebot.utils](utils.md) - * [nonebot.typing](typing.html) + * [nonebot.typing](typing.md) - * [nonebot.exception](exception.html) + * [nonebot.exception](exception.md) * [nonebot.drivers](drivers/) - * [nonebot.drivers.fastapi](drivers/fastapi.html) + * [nonebot.drivers.fastapi](drivers/fastapi.md) * [nonebot.adapters](adapters/) - * [nonebot.adapters.cqhttp](adapters/cqhttp.html) + * [nonebot.adapters.cqhttp](adapters/cqhttp.md) diff --git a/docs_build/README.rst b/docs_build/README.rst index 02d097be..716c153c 100644 --- a/docs_build/README.rst +++ b/docs_build/README.rst @@ -2,18 +2,18 @@ NoneBot Api Reference ===================== :模块索引: - - `nonebot `_ - - `nonebot.config `_ - - `nonebot.plugin `_ - - `nonebot.matcher `_ - - `nonebot.rule `_ - - `nonebot.permission `_ - - `nonebot.sched `_ - - `nonebot.log `_ - - `nonebot.utils `_ - - `nonebot.typing `_ - - `nonebot.exception `_ + - `nonebot `_ + - `nonebot.config `_ + - `nonebot.plugin `_ + - `nonebot.matcher `_ + - `nonebot.rule `_ + - `nonebot.permission `_ + - `nonebot.sched `_ + - `nonebot.log `_ + - `nonebot.utils `_ + - `nonebot.typing `_ + - `nonebot.exception `_ - `nonebot.drivers `_ - - `nonebot.drivers.fastapi `_ + - `nonebot.drivers.fastapi `_ - `nonebot.adapters `_ - - `nonebot.adapters.cqhttp `_ + - `nonebot.adapters.cqhttp `_