Skip to content

Commit 0c67a32

Browse files
authored
docs: update templates (#2)
1 parent 60a857f commit 0c67a32

File tree

6 files changed

+134
-3
lines changed

6 files changed

+134
-3
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve this project.
4+
title: "[BUG] "
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Describe the bug
11+
(A clear and concise description of what the bug is.)
12+
13+
## How To Reproduce
14+
Steps to reproduce the behavior:
15+
1. Config/File changes: ...
16+
2. Run command: ...
17+
3. See error: ...
18+
19+
## Expected behavior
20+
(A clear and concise description of what you expected to happen.)
21+
22+
## Screenshots
23+
(If applicable, add screenshots to help explain your problem.)
24+
25+
## Environment Information
26+
- Operating System: [e.g. Ubuntu 20.04.5 LTS]
27+
- Python Version: [e.g. Python 3.9.15]
28+
- Driver & CUDA Version: [e.g. Driver 470.103.01 & CUDA 11.4]
29+
- Error Messages and Logs: [If applicable, provide any error messages or relevant log outputs]
30+
31+
## Additional context
32+
(Add any other context about the problem here.)
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Docs feedback
3+
about: Improve documentation about this project.
4+
title: "[Docs] "
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Documentation Reference
11+
(Path/Link to the documentation file)
12+
13+
## Feedback on documentation
14+
(Your suggestions to the documentation. e.g., accuracy, complex explanations, structural organization, practical examples, technical reliability, and consistency)
15+
16+
## Additional context
17+
(Add any other context or screenshots about the documentation here.)
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project.
4+
title: "[Feature] "
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Is your feature request related to a problem? Please describe.
11+
(A clear and concise description of what the problem is.)
12+
13+
## Describe the solution you'd like
14+
(A clear and concise description of what you want to happen.)
15+
16+
## Describe alternatives you've considered
17+
(A clear and concise description of any alternative solutions or features you've considered.)
18+
19+
## Additional context
20+
(Add any other context or screenshots about the feature request here.)
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Help wanted
3+
about: Want help from this project team.
4+
title: "[Help] "
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Problem Overview
11+
(Briefly and clearly describe the issue you're facing and seeking help with.)
12+
13+
## Steps Taken
14+
(Detail your attempts to resolve the issue, including any relevant steps or processes.)
15+
1. Config/File changes: ...
16+
2. Run command: ...
17+
3. See errors: ...
18+
19+
## Expected Outcome
20+
(A clear and concise description of what you expected to happen.)
21+
22+
## Screenshots
23+
(If applicable, add screenshots to help explain your problem.)
24+
25+
## Environment Information
26+
- Operating System: [e.g. Ubuntu 20.04.5 LTS]
27+
- Python Version: [e.g. Python 3.9.15]
28+
- Driver & CUDA Version: [e.g. Driver 470.103.01 & CUDA 11.4]
29+
- Error Messages and Logs: [If applicable, provide any error messages or relevant log outputs]
30+
31+
## Additional context
32+
(Add any other context about the problem here.)

.github/pull_request_template.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
## Description
3+
4+
[Please describe the background, purpose, changes made, and how to test this PR]
5+
6+
## Related Issues
7+
8+
[List the issue numbers related to this PR]
9+
10+
## Changes Proposed
11+
12+
- [ ] change1
13+
- [ ] ...
14+
15+
## Who Can Review?
16+
17+
[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.]
18+
19+
## TODO
20+
21+
- [ ] task1
22+
- [ ] ...
23+
24+
## Checklist
25+
26+
- [ ] Code has been reviewed
27+
- [ ] Code complies with the project's code standards and best practices
28+
- [ ] Code has passed all tests
29+
- [ ] Code does not affect the normal use of existing features
30+
- [ ] Code has been commented properly
31+
- [ ] Documentation has been updated (if applicable)
32+
- [ ] Demo/checkpoint has been attached (if applicable)

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,5 @@ brew install ffmpeg
4646

4747

4848
```bash
49-
python autostream.py --server_url <server_url> --key <key> --file <input_file>
49+
python -m autostream.cli bili --server_url <server_url> --key <key> --file <input_file>
5050
```
51-
52-

0 commit comments

Comments
 (0)