Skip to content

Commit e5d48b9

Browse files
cainmagicainmagi
committed
3.1.0
1. Add github configurations and community files. 2. Drop the legacy documentation.
1 parent c2f41bf commit e5d48b9

10 files changed

+498
-205
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

+97
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
name: Bug report
2+
description: Something is not working correctly.
3+
title: "[BUG]"
4+
labels: "bug, to be solved"
5+
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Get started
10+
options:
11+
- label: >-
12+
I have read [Contributing guidelines](https://github.com/cainmagi/FFmpeg-Encoder-Decoder-for-Python/blob/master/CONTRIBUTING.md).
13+
required: true
14+
- label: >-
15+
I have confirmed that my problem could not be solved by the [troubleshooting](https://cainmagi.github.io/FFmpeg-Encoder-Decoder-for-Python/docs/troubleshooting/installation) section in the documentation.
16+
required: true
17+
- label: >-
18+
I agree to follow the [Code of Conduct](https://github.com/cainmagi/FFmpeg-Encoder-Decoder-for-Python/blob/master/CODE_OF_CONDUCT.md).
19+
required: true
20+
- label: >-
21+
I have confirmed that my issue is not duplicated with an existing issue.
22+
required: true
23+
24+
- type: textarea
25+
attributes:
26+
label: Description
27+
description: >-
28+
A clear and concise description of what the bug is.
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
attributes:
34+
label: To Reproduce
35+
description: >-
36+
Steps to reproduce the behavior. Instead of describing the steps, you could also provide your codes related to the error here.
37+
value: |
38+
1. Get package from '...'
39+
2. Then run '...'
40+
3. An error occurs.
41+
42+
- type: textarea
43+
attributes:
44+
label: Traceback
45+
description: >-
46+
The python trackback of the bug. If there is no traceback, please describe (1) The expected behaviors. (2) The actual behaviors.
47+
render: sh-session
48+
49+
- type: textarea
50+
attributes:
51+
label: Behaviors
52+
description: >-
53+
If there is no traceback, please describe (1) The expected behaviors. (2) The actual behaviors.
54+
value: |
55+
1. The expected behaviors:
56+
2. The actual behaviors:
57+
58+
- type: textarea
59+
attributes:
60+
label: Screenshots
61+
description: >-
62+
If applicable, add screenshots to help explain your problem.
63+
64+
- type: input
65+
attributes:
66+
label: OS
67+
description: >-
68+
e.g. Ubuntu 20.04, Debian 10, Windows 10 21H1
69+
validations:
70+
required: true
71+
- type: input
72+
attributes:
73+
label: Python version
74+
description: >-
75+
e.g. 3.8
76+
validations:
77+
required: true
78+
- type: input
79+
attributes:
80+
label: numpy version
81+
description: >-
82+
e.g. 1.21.1
83+
validations:
84+
required: true
85+
- type: input
86+
attributes:
87+
label: mpegCoder version
88+
description: >-
89+
e.g. 3.1.0
90+
validations:
91+
required: true
92+
93+
- type: textarea
94+
attributes:
95+
label: Additional context
96+
description: >-
97+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/docs_request.yml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Docs request
2+
description: Report a problem or a request for the docs.
3+
title: "[Docs]"
4+
labels: documentation, to be solved
5+
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Get started
10+
options:
11+
- label: >-
12+
I have read [Contributing guidelines](https://github.com/cainmagi/FFmpeg-Encoder-Decoder-for-Python/blob/master/CONTRIBUTING.md).
13+
required: true
14+
- label: >-
15+
I agree to follow the [Code of Conduct](https://github.com/cainmagi/FFmpeg-Encoder-Decoder-for-Python/blob/master/CODE_OF_CONDUCT.md).
16+
required: true
17+
- label: >-
18+
I have confirmed that my issue is not duplicated with an existing issue.
19+
required: true
20+
21+
- type: textarea
22+
attributes:
23+
label: Problem
24+
description: >-
25+
If you meet any problems with the documentation, please describe your problems here.
26+
27+
- type: textarea
28+
attributes:
29+
label: Required feature
30+
description: >-
31+
If you need more explanations in the documentation, please describe your needs here.
32+
33+
- type: input
34+
attributes:
35+
label: mpegCoder version
36+
description: >-
37+
e.g. 3.1.0
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
attributes:
43+
label: Additional context
44+
description: >-
45+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.yml

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
title: "[Feature]"
4+
labels: enhancement, to be solved
5+
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Get started
10+
options:
11+
- label: >-
12+
I have read [Contributing guidelines](https://github.com/cainmagi/FFmpeg-Encoder-Decoder-for-Python/blob/master/CONTRIBUTING.md).
13+
required: true
14+
- label: >-
15+
I agree to follow the [Code of Conduct](https://github.com/cainmagi/FFmpeg-Encoder-Decoder-for-Python/blob/master/CODE_OF_CONDUCT.md).
16+
required: true
17+
- label: >-
18+
I have confirmed that my issue is not duplicated with an existing issue.
19+
required: true
20+
21+
- type: textarea
22+
attributes:
23+
label: Problem
24+
description: >-
25+
If your feature request is related to a problem, please describe the problem clearly and concisely.
26+
27+
- type: textarea
28+
attributes:
29+
label: Required feature
30+
description: >-
31+
A clear and concise description of what you want to happen.
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
attributes:
37+
label: Alternative solution
38+
description: >-
39+
A clear and concise description of any alternative solutions or features you've considered.
40+
41+
- type: input
42+
attributes:
43+
label: mpegCoder version
44+
description: >-
45+
e.g. 3.1.0
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
attributes:
51+
label: Additional context
52+
description: >-
53+
Add any other context about the problem here.

‎.github/PULL_REQUEST_TEMPLATE.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Pull request
2+
3+
## Get started
4+
5+
- [ ] I have read [Contributing guidelines](https://github.com/cainmagi/FFmpeg-Encoder-Decoder-for-Python/blob/master/CONTRIBUTING.md).
6+
- [ ] I agree to follow the [Code of Conduct](https://github.com/cainmagi/FFmpeg-Encoder-Decoder-for-Python/blob/master/CODE_OF_CONDUCT.md).
7+
- [ ] I have confirmed that my pull request (PR) is not duplicated with an existing PR.
8+
- [ ] I have confirmed that my pull request (PR) passes the testing workflow of the project.
9+
10+
## Description
11+
12+
Describe what you have done with this PR. List any dependencies that are required for this change.
13+
14+
If your PR is designed for an issue, please refer to the issue by the following example:
15+
16+
Fixes # (issue)
17+
18+
## Updated report
19+
20+
Please summarize your modifications as an itemized report.
21+
22+
1. Update ...
23+
2. Add ...
24+
25+
## Information
26+
27+
Please provide the following information about your PR:
28+
29+
- `mpegCoder` version:
30+
31+
## Additional context
32+
33+
Add any other context about the problem here.

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Pull request
2+
3+
## Get started
4+
5+
- [ ] I have read [Contributing guidelines](https://github.com/cainmagi/FFmpeg-Encoder-Decoder-for-Python/blob/master/CONTRIBUTING.md).
6+
- [ ] I agree to follow the [Code of Conduct](https://github.com/cainmagi/FFmpeg-Encoder-Decoder-for-Python/blob/master/CODE_OF_CONDUCT.md).
7+
- [ ] I have confirmed that my pull request (PR) is not duplicated with an existing PR.
8+
- [ ] I have confirmed that my pull request (PR) passes the testing workflow of the project.
9+
10+
## Description
11+
12+
Describe what you have done with this PR. List any dependencies that are required for this change.
13+
14+
If your PR is designed for an issue, please refer to the issue by the following example:
15+
16+
Fixes # (issue)
17+
18+
## Updated report
19+
20+
Please summarize your modifications as an itemized report.
21+
22+
1. Update ...
23+
2. Add ...
24+
25+
## Information
26+
27+
Please provide the following information about your PR:
28+
29+
- `mpegCoder` version:
30+
31+
## Additional context
32+
33+
Add any other context about the problem here.

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.yml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Pull request
2+
description: Send a pull request (PR) for this project.
3+
title: "[PR]"
4+
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Get started
9+
options:
10+
- label: >-
11+
I have read [Contributing guidelines](https://github.com/cainmagi/FFmpeg-Encoder-Decoder-for-Python/blob/master/CONTRIBUTING.md).
12+
required: true
13+
- label: >-
14+
I agree to follow the [Code of Conduct](https://github.com/cainmagi/FFmpeg-Encoder-Decoder-for-Python/blob/master/CODE_OF_CONDUCT.md).
15+
required: true
16+
- label: >-
17+
I have confirmed that my pull request (PR) is not duplicated with an existing PR.
18+
required: true
19+
- label: >-
20+
I have confirmed that my pull request (PR) passes the testing workflow of the project.
21+
required: true
22+
23+
- type: textarea
24+
attributes:
25+
label: Description
26+
description: >-
27+
Describe what you have done with this PR.
28+
29+
- type: textarea
30+
attributes:
31+
label: Updated report
32+
description: >-
33+
Summarize your modifications as itemized report.
34+
value: |
35+
1. Update ...
36+
2. Add ...
37+
38+
- type: input
39+
attributes:
40+
label: mpegCoder version
41+
description: >-
42+
e.g. 3.1.0
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
attributes:
48+
label: Additional context
49+
description: >-
50+
Add any other context about the problem here.

0 commit comments

Comments
 (0)