-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d378a0a
commit e5facda
Showing
1 changed file
with
24 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,25 +6,29 @@ The following is a set of guidelines for contributing to api.video and its packa | |
|
|
||
| #### Table of contents | ||
|
|
||
| [Code of Conduct](#code-of-conduct) | ||
|
|
||
| [I just have a question!](#i-just-have-a-question) | ||
|
|
||
| [How Can I Contribute?](#how-can-i-contribute) | ||
| * [Reporting Bugs](#reporting-bugs) | ||
| * [Suggesting Enhancements](#suggesting-enhancements) | ||
| * [Pull Requests](#pull-requests) | ||
|
|
||
| [Styleguides](#styleguides) | ||
| * [Git Commit Messages](#git-commit-messages) | ||
| * [Documentation Styleguide](#documentation-styleguide) | ||
|
|
||
| [Additional Notes](#additional-notes) | ||
| * [Issue and Pull Request Labels](#issue-and-pull-request-labels) | ||
|
|
||
| - [Contributing to api.video](#contributing-to-apivideo) | ||
| - [Table of contents](#table-of-contents) | ||
| - [Code of conduct](#code-of-conduct) | ||
| - [I just have a question!](#i-just-have-a-question) | ||
| - [How can I contribute?](#how-can-i-contribute) | ||
| - [Reporting bugs](#reporting-bugs) | ||
| - [Before submitting a bug report](#before-submitting-a-bug-report) | ||
| - [How do I submit a (good) bug report?](#how-do-i-submit-a-good-bug-report) | ||
| - [Suggesting enhancements](#suggesting-enhancements) | ||
| - [How do I submit a (good) enhancement suggestion?](#how-do-i-submit-a-good-enhancement-suggestion) | ||
| - [Pull requests](#pull-requests) | ||
| - [Style guides](#style-guides) | ||
| - [Git commit messages](#git-commit-messages) | ||
| - [Documentation style guide](#documentation-style-guide) | ||
| - [Additional notes](#additional-notes) | ||
| - [Issue and pull request Llabels](#issue-and-pull-request-llabels) | ||
| - [Type of issue and issue state](#type-of-issue-and-issue-state) | ||
| - [Topic categories](#topic-categories) | ||
| - [Pull request labels](#pull-request-labels) | ||
|
|
||
| ## Code of conduct | ||
|
|
||
| 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 [[email protected]](mailto:[email protected]). | ||
| 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 [[email protected]](mailto:[email protected]). | ||
|
|
||
| ## I just have a question! | ||
|
|
||
|
|
@@ -42,7 +46,7 @@ We have an official message board with a detailed FAQ and where the community ch | |
|
|
||
| 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:. | ||
|
|
||
| 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/api.video-contribution/blob/main/.github/ISSUE_TEMPLATE/bug_report.md), the information it asks for helps us resolve issues faster. | ||
| 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. | ||
|
|
||
| > **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. | ||
|
|
@@ -54,7 +58,7 @@ Before creating bug reports, please check [this list](#before-submitting-a-bug-r | |
|
|
||
| #### How do I submit a (good) bug report? | ||
|
|
||
| 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/api.video-contribution/blob/main/.github/ISSUE_TEMPLATE/bug_report.md). | ||
| 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). | ||
|
|
||
| Explain the problem and include additional details to help maintainers reproduce the problem: | ||
|
|
||
|
|
@@ -81,7 +85,7 @@ Include details about your configuration and environment: | |
|
|
||
| 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:. | ||
|
|
||
| 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/api.video-contribution/blob/main/.github/ISSUE_TEMPLATE/feature_request.md), including the steps that you imagine you would take if the feature you're requesting existed. | ||
| 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. | ||
|
|
||
|
|
||
| #### How do I submit a (good) enhancement suggestion? | ||
|
|
||