From efe4dff530937af18345ac2ebbdd42f5666298d2 Mon Sep 17 00:00:00 2001 From: John Howe <89397553+timerring@users.noreply.github.com> Date: Wed, 19 Mar 2025 23:02:38 +0800 Subject: [PATCH] docs: update templates --- .github/ISSUE_TEMPLATE/bug_report.md | 32 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/docs-feedback.md | 17 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++ .github/ISSUE_TEMPLATE/help-wanted.md | 32 +++++++++++++++++++++++ .github/pull_request_template.md | 32 +++++++++++++++++++++++ README.md | 4 +-- 6 files changed, 134 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/docs-feedback.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/help-wanted.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..160071d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve this project. +title: "[BUG] " +labels: '' +assignees: '' + +--- + +## Describe the bug +(A clear and concise description of what the bug is.) + +## How To Reproduce +Steps to reproduce the behavior: +1. Config/File changes: ... +2. Run command: ... +3. See error: ... + +## Expected behavior +(A clear and concise description of what you expected to happen.) + +## Screenshots +(If applicable, add screenshots to help explain your problem.) + +## Environment Information + - Operating System: [e.g. Ubuntu 20.04.5 LTS] + - Python Version: [e.g. Python 3.9.15] + - Driver & CUDA Version: [e.g. Driver 470.103.01 & CUDA 11.4] + - Error Messages and Logs: [If applicable, provide any error messages or relevant log outputs] + +## Additional context +(Add any other context about the problem here.) diff --git a/.github/ISSUE_TEMPLATE/docs-feedback.md b/.github/ISSUE_TEMPLATE/docs-feedback.md new file mode 100644 index 0000000..d5011e5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs-feedback.md @@ -0,0 +1,17 @@ +--- +name: Docs feedback +about: Improve documentation about this project. +title: "[Docs] " +labels: '' +assignees: '' + +--- + +## Documentation Reference +(Path/Link to the documentation file) + +## Feedback on documentation +(Your suggestions to the documentation. e.g., accuracy, complex explanations, structural organization, practical examples, technical reliability, and consistency) + +## Additional context +(Add any other context or screenshots about the documentation here.) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..78f443e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project. +title: "[Feature] " +labels: '' +assignees: '' + +--- + +## 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.) + +## 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.) diff --git a/.github/ISSUE_TEMPLATE/help-wanted.md b/.github/ISSUE_TEMPLATE/help-wanted.md new file mode 100644 index 0000000..70454b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/help-wanted.md @@ -0,0 +1,32 @@ +--- +name: Help wanted +about: Want help from this project team. +title: "[Help] " +labels: '' +assignees: '' + +--- + +## Problem Overview +(Briefly and clearly describe the issue you're facing and seeking help with.) + +## Steps Taken +(Detail your attempts to resolve the issue, including any relevant steps or processes.) +1. Config/File changes: ... +2. Run command: ... +3. See errors: ... + +## Expected Outcome +(A clear and concise description of what you expected to happen.) + +## Screenshots +(If applicable, add screenshots to help explain your problem.) + +## Environment Information + - Operating System: [e.g. Ubuntu 20.04.5 LTS] + - Python Version: [e.g. Python 3.9.15] + - Driver & CUDA Version: [e.g. Driver 470.103.01 & CUDA 11.4] + - Error Messages and Logs: [If applicable, provide any error messages or relevant log outputs] + +## Additional context +(Add any other context about the problem here.) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..a536938 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,32 @@ + +## Description + +[Please describe the background, purpose, changes made, and how to test this PR] + +## Related Issues + +[List the issue numbers related to this PR] + +## Changes Proposed + +- [ ] change1 +- [ ] ... + +## Who Can Review? + +[Please use the '@' symbol to mention any community member who is free to review the PR once the tests have passed. Feel free to tag members or contributors who might be interested in your PR.] + +## TODO + +- [ ] task1 +- [ ] ... + +## Checklist + +- [ ] Code has been reviewed +- [ ] Code complies with the project's code standards and best practices +- [ ] Code has passed all tests +- [ ] Code does not affect the normal use of existing features +- [ ] Code has been commented properly +- [ ] Documentation has been updated (if applicable) +- [ ] Demo/checkpoint has been attached (if applicable) diff --git a/README.md b/README.md index 5cf1de1..2654a9b 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,5 @@ brew install ffmpeg ```bash -python autostream.py --server_url --key --file +python -m autostream.cli bili --server_url --key --file ``` - -