You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[Issue and pull request labels](#issue-and-pull-request-labels)
22
25
-[Type of issue and issue state](#type-of-issue-and-issue-state)
23
26
-[Topic categories](#topic-categories)
24
-
27
+
-[Pull request labels](#pull-request-labels)
28
+
25
29
## Code of conduct
26
30
27
-
This project and everyone participating in it is governed by the [api.video Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [help@api.video](mailto:help@api.video).
31
+
This project and everyone participating in it is governed by the [api.video Code of Conduct](https://github.com/apivideo/.github/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [help@api.video](mailto:help@api.video).
28
32
29
33
## I just have a question!
30
34
@@ -42,7 +46,7 @@ We have an official message board with a detailed FAQ and where the community ch
42
46
43
47
This section guides you through submitting a bug report for api.video. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer:, and find related reports :mag_right:.
44
48
45
-
Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/apivideo/.github/blob/main/.github/ISSUE_TEMPLATE/bug_report.md), the information it asks for helps us resolve issues faster.
49
+
Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/apivideo/.github/blob/main/.github/ISSUE_TEMPLATE/bug_report.yml), the information it asks for helps us resolve issues faster.
46
50
47
51
> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). After you've determined which repository your bug is related to, create an issue on that repository and provide the following information by filling in [the template](https://github.com/apivideo/.github/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).
61
+
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). After you've determined which repository your bug is related to, create an issue on that repository and provide the following information by filling in [the template](https://github.com/apivideo/.github/blob/main/.github/ISSUE_TEMPLATE/bug_report.yml).
58
62
59
63
Explain the problem and include additional details to help maintainers reproduce the problem:
60
64
@@ -81,7 +85,7 @@ Include details about your configuration and environment:
81
85
82
86
This section guides you through submitting an enhancement suggestion for api.video project, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.
83
87
84
-
When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/apivideo/.github/blob/main/.github/ISSUE_TEMPLATE/feature_request.md), including the steps that you imagine you would take if the feature you're requesting existed.
88
+
When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/apivideo/.github/blob/main/.github/ISSUE_TEMPLATE/feature_request.yml), including the steps that you imagine you would take if the feature you're requesting existed.
85
89
86
90
87
91
#### How do I submit a (good) enhancement suggestion?
@@ -100,15 +104,55 @@ Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com
100
104
101
105
### Pull requests
102
106
103
-
Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository.
104
-
If you want to contribute, you can open a pull request on the repository of our [client generator](https://github.com/apivideo/api.video-api-client-generator).
105
-
Otherwise, you can also simply open an issue detailing your need on this repository.
107
+
The process described here has several goals:
108
+
109
+
- Maintain api.video's quality
110
+
- Fix problems that are important to users
111
+
- Engage the community in working toward the best possible api.video
112
+
- Enable a sustainable system for api.video's maintainers to review contributions
113
+
114
+
Please follow these steps to have your contribution considered by the maintainers:
115
+
116
+
1. Explain what, why and how you resolved the issue. If you have a related issue, please mention it.
117
+
2. Follow the [style guides](#style-guides)
118
+
3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing <details><summary>What if the status checks are failing?</summary>If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.</details>
119
+
120
+
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
121
+
122
+
## Style guides
123
+
124
+
### Git commit messages
125
+
126
+
* Use the present tense ("Add feature" not "Added feature")
127
+
* Limit the first line to 72 characters or less
128
+
* Reference issues and pull requests after the first line
129
+
* Consider starting the commit message with an applicable emoji:
130
+
*:art:`:art:` when improving the format/structure of the code
131
+
*:racehorse:`:racehorse:` when improving performance
132
+
*:non-potable_water:`:non-potable_water:` when plugging memory leaks
133
+
*:memo:`:memo:` when writing docs
134
+
*:penguin:`:penguin:` when fixing something on Linux
135
+
*:apple:`:apple:` when fixing something on macOS
136
+
*:checkered_flag:`:checkered_flag:` when fixing something on Windows
137
+
*:bug:`:bug:` when fixing a bug
138
+
*:fire:`:fire:` when removing code or files
139
+
*:green_heart:`:green_heart:` when fixing the CI build
140
+
*:white_check_mark:`:white_check_mark:` when adding tests
141
+
*:lock:`:lock:` when dealing with security
142
+
*:arrow_up:`:arrow_up:` when upgrading dependencies
143
+
*:arrow_down:`:arrow_down:` when downgrading dependencies
144
+
*:shirt:`:shirt:` when removing linter warnings
145
+
146
+
### Documentation style guide
147
+
148
+
* Use [Markdown](https://daringfireball.net/projects/markdown).
149
+
106
150
107
151
## Additional notes
108
152
109
-
### Issue labels
153
+
### Issue and pull request labels
110
154
111
-
This section lists the labels we use to help us track and manage issues on all api.video repositories.
155
+
This section lists the labels we use to help us track and manage issues and pull requests on all api.video repositories.
112
156
113
157
[GitHub search](https://help.github.com/articles/searching-issues/) makes it easy to use labels for finding groups of issues or pull requests you're interested in. We encourage you to read about [other search filters](https://help.github.com/articles/searching-issues/) which will help you write more focused queries.
114
158
@@ -144,6 +188,15 @@ This section lists the labels we use to help us track and manage issues on all a
144
188
|`ui`|[search][search-apivideo-org-label-ui]| Related to visual design. |
145
189
|`api`|[search][search-apivideo-org-label-api]| Related to api.video's public APIs. |
146
190
191
+
#### Pull request labels
192
+
193
+
| Label name | `apivideo`:mag_right: | Description
194
+
| --- | --- | --- |
195
+
|`work-in-progress`|[search][search-apivideo-org-label-work-in-progress]| Pull requests which are still being worked on, more changes will follow. |
196
+
|`needs-review`|[search][search-apivideo-org-label-needs-review]| Pull requests which need code review, and approval from maintainers or api.video team. |
197
+
|`under-review`|[search][search-apivideo-org-label-under-review]| Pull requests being reviewed by maintainers or api.video team. |
198
+
|`requires-changes`|[search][search-apivideo-org-label-requires-changes]| Pull requests which need to be updated based on review comments and then reviewed again. |
199
+
|`needs-testing`|[search][search-apivideo-org-label-needs-testing]| Pull requests which need manual testing. |
0 commit comments