🎥👍🎉 Thank you for taking the time to contribute and participate in the implementation of a Video First World! 🎉👍🎥
The following is a set of guidelines for contributing to api.video and its packages, which are hosted in the api.video Organization on GitHub.
- Contributing to api.video - Table of contents
This project and everyone participating in it is governed by the api.video Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to help@api.video.
Note: [Please don't file an issue to ask a question.] You'll get faster results by using the resources below.
We have an official message board with a detailed FAQ and where the community chimes in with helpful advice if you have questions.
This section guides you through submitting a bug report for api.video. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻, and find related reports 🔎.
Before creating bug reports, please check this list 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. Fill out the required template, the information it asks for helps us resolve issues faster.
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.
- Check the The official api.video's Community for a list of common questions and problems.
- Determine which repository the problem should be reported in.
- Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Bugs are tracked as GitHub 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.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots or videos which show you following the described steps and clearly demonstrate the problem.
- If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
Provide more context by answering these questions:
- Did the problem start happening recently (e.g. after updating to a new version of api.video) or was this always a problem?
- If the problem started happening recently.**
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
Include details about your configuration and environment:
- Which version of the api.video package are you using?
- What's the name and version of the OS you're using?
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 📝 and find related suggestions 🔎.
When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
Enhancement suggestions are tracked as GitHub issues. After you've determined which repository your enhancement suggestion is related to, create an issue on that repository and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Include screenshots which help you demonstrate the steps or point out the part of api.video which the suggestion is related to.
- Explain why this enhancement would be useful to most api.video users and isn't something that can or should be implemented as a community package.
- Specify which version of the api.video package you're using.
- Specify the name and version of the OS you're using.
The process described here has several goals:
- Maintain api.video's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible api.video
- Enable a sustainable system for api.video's maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Explain what, why and how you resolved the issue. If you have a related issue, please mention it.
- Follow the style guides
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
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.
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.
- Use the present tense ("Add feature" not "Added feature")
- Limit the first line to 72 characters or less
- Reference issues and pull requests after the first line
- Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 🚱
:non-potable_water:when plugging memory leaks - 📝
:memo:when writing docs - 🐧
:penguin:when fixing something on Linux - 🍎
:apple:when fixing something on macOS - 🏁
:checkered_flag:when fixing something on Windows - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 💚
:green_heart:when fixing the CI build - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 👕
:shirt:when removing linter warnings
- 🎨
- Use Markdown.
This section lists the labels we use to help us track and manage issues and pull requests on all api.video repositories.
GitHub search 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 which will help you write more focused queries.
| Label name | apivideo 🔎 |
Description |
|---|---|---|
enhancement |
search | Feature requests. |
bug |
search | Confirmed bugs or reports that are very likely to be bugs. |
question |
search | Questions more than bug reports or feature requests (e.g. how do I do X). |
feedback |
search | General feedback more than bug reports or feature requests. |
help-wanted |
search | The api.video team would appreciate help from the community in resolving these issues. |
more-information-needed |
search | More information needs to be collected about these problems or feature requests (e.g. steps to reproduce). |
needs-reproduction |
search | Likely bugs, but haven't been reliably reproduced. |
blocked |
search | Issues blocked on other issues. |
duplicate |
search | Issues which are duplicates of other issues, i.e. they have been reported before. |
wontfix |
search | The api.video team has decided not to fix these issues for now, either because they're working as intended or for some other reason. |
invalid |
search | Issues which aren't valid (e.g. user errors). |
package-idea |
search | Feature request which might be good candidates for new packages, instead of extending api.video packages. |
wrong-repo |
search | Issues reported on the wrong repository. |
| Label name | apivideo 🔎 |
Description |
|---|---|---|
windows |
search | Related to api.video running on Windows. |
linux |
search | Related to api.video running on Linux. |
mac |
search | Related to api.video running on macOS. |
documentation |
search | Related to any type of documentation. |
performance |
search | Related to performance. |
security |
search | Related to security. |
ui |
search | Related to visual design. |
api |
search | Related to api.video's public APIs. |
| Label name | apivideo 🔎 |
Description |
|---|---|---|
work-in-progress |
search | Pull requests which are still being worked on, more changes will follow. |
needs-review |
search | Pull requests which need code review, and approval from maintainers or api.video team. |
under-review |
search | Pull requests being reviewed by maintainers or api.video team. |
requires-changes |
search | Pull requests which need to be updated based on review comments and then reviewed again. |
needs-testing |
search | Pull requests which need manual testing. |