-
Notifications
You must be signed in to change notification settings - Fork 477
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added issues templates and PR templates
- Loading branch information
Showing
5 changed files
with
277 additions
and
0 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 |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| name: 🐛 Bug Report | ||
| description: Report bugs to fix and improve. | ||
| title: "[BUG] <description>" | ||
| labels: ["bug"] | ||
|
|
||
|
|
||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Describe the bug. | ||
| description: A clear and concise description of what the bug is. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: Expected behavior | ||
| description: A clear and concise description of what you expected to happen. | ||
| validations: | ||
| required: true | ||
|
|
||
|
|
||
| - type: textarea | ||
| id: screenshots | ||
| attributes: | ||
| label: Screenshots | ||
| description: Please add screenshots/video of the bug you faced. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| id: reproduce | ||
| attributes: | ||
| label: How to Reproduce | ||
| description: Attach all steps/share a github gist that can help anyone reproduce the bug. | ||
| value: | | ||
| 1. I first did this | ||
| 2. I then did this | ||
| 3. And so on . . . | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| id: browser | ||
| attributes: | ||
| label: "🥦 Browser" | ||
| description: "What browser are you using?" | ||
| options: | ||
| - Google Chrome | ||
| - Brave | ||
| - Microsoft Edge | ||
| - Mozilla Firefox | ||
| - Safari | ||
| - Opera | ||
| - Other | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: checkboxes | ||
| id: no-duplicate-issues | ||
| attributes: | ||
| label: "👀 Have you checked for similar open issues?" | ||
| options: | ||
| - label: "I checked and didn't find similar issue" | ||
| required: true | ||
|
|
||
| - type: checkboxes | ||
| id: read-code-of-conduct | ||
| attributes: | ||
| label: "🏢 Have you read the Contributing Guidelines?" | ||
| options: | ||
| - label: "I have read the Contributing Guidelines" | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| attributes: | ||
| label: Are you willing to work on this issue ? | ||
| description: This is absolutely not required, but we are happy to guide you in the contribution process. | ||
| options: | ||
| - "Yes I am willing to submit a PR!" | ||
| - "No, someone else can work on it" |
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 |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| name: Docs Bug 🐞 report | ||
| description: Report mistakes and/or bugs in Jitsi Docs. | ||
| title: "[Docs Bug 🐞 report]: " | ||
| labels: ["🐞 docs bug"] | ||
|
|
||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for reporting mistakes and/or bugs 🐞 in Jitsi Docs 📑. We appreciate your contribution! 🙂 | ||
| - type: textarea | ||
| id: describe-bug | ||
| attributes: | ||
| label: Describe the bug you found in Jitsi Docs. | ||
| description: Is there a bug in one of our code snippets? Did we explain a concept incorrectly? Please share a clear and concise description of what the bug or mistake is. | ||
| placeholder: "I would like to file an Jitsi Docs Bug 🐞 report about..." | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: reproduce-bug | ||
| attributes: | ||
| label: Attach any resources that can help us understand the issue. | ||
| description: Send us screenshots, direct quotes of the text that has issues, a link to the GitHub repository with project that has issues, etc. Help us reproduce this Docs issue. | ||
| placeholder: "Please find attached a screenshot of the text with issues..." | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our Code of Conduct | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| attributes: | ||
| label: Are you willing to work on this issue ? | ||
| description: This is absolutely not required, but we are happy to guide you in the contribution process. | ||
| options: | ||
| - "Yes I am willing to submit a PR!" | ||
| - "No, someone else can work on it" |
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 |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| name: 📑 Docs | ||
| description: Propose changes and improvements to Jitsi Docs. | ||
| labels: ["📑 docs"] | ||
| title: "[📑 Docs]: " | ||
|
|
||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for contributing to Jisti Docs! 📑 👩🏻💻 We appreciate your feedback, ideas, and contributions. | ||
| - type: textarea | ||
| id: reason-context | ||
| attributes: | ||
| label: What Dev Docs changes are you proposing? | ||
| description: Why do the Docs need this improvement? What is the motivation for this change? How will this change benefit our Open-Source community? | ||
| placeholder: "I would like to contribute to JItsi Docs 📑 by..." | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our Code of Conduct | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| attributes: | ||
| label: Are you willing to work on this issue ? | ||
| description: This is absolutely not required, but we are happy to guide you in the contribution process. | ||
| options: | ||
| - "Yes I am willing to submit a PR!" | ||
| - "No, someone else can work on it" | ||
|
|
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 |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| name: 💡 Feature Request | ||
| description: Suggest a new idea/feature | ||
| title: "[FEATURE] <description>" | ||
| labels: ["enhancement"] | ||
|
|
||
| body: | ||
| - type: textarea | ||
| id: need_improvement | ||
| attributes: | ||
| label: Why do we need this improvement? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: change | ||
| attributes: | ||
| label: How will this change help? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: screenshots | ||
| attributes: | ||
| label: Screenshots | ||
| description: Please add screenshots if applicable | ||
| validations: | ||
| required: false | ||
|
|
||
|
|
||
| - type: textarea | ||
| id: implemented | ||
| attributes: | ||
| label: How could it be implemented/designed? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| id: breakingchange | ||
| attributes: | ||
| label: "🚧 Breaking changes" | ||
| description: "Will this be a breaking change?" | ||
| options: | ||
| - "Yes" | ||
| - "No" | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: checkboxes | ||
| id: no-duplicate-issues | ||
| attributes: | ||
| label: "👀 Have you checked for similar open issues?" | ||
| options: | ||
| - label: "I checked and didn't find a similar issue" | ||
| required: true | ||
|
|
||
| - type: checkboxes | ||
| id: read-code-of-conduct | ||
| attributes: | ||
| label: "🏢 Have you read the Contributing Guidelines?" | ||
| options: | ||
| - label: "I have read the Contributing Guidelines" | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| attributes: | ||
| label: Are you willing to work on this issue? | ||
| description: This is absolutely not required, but we are happy to guide you in the contribution process. | ||
| options: | ||
| - "Yes I am willing to submit a PR!" | ||
| - "No, someone else can work on it." |
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 |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| <!--- Provide a general summary of your changes in the Title above --> | ||
|
|
||
| ## Description | ||
|
|
||
| <!--- Describe your changes in detail --> | ||
|
|
||
| ## Related Issue | ||
|
|
||
| <!--- This project only accepts pull requests related to open issues --> | ||
| <!--- If suggesting a new feature or change, please discuss it in an issue first --> | ||
| <!--- If fixing a bug, there should be an issue describing it with steps to reproduce --> | ||
| <!--- Please link to the issue here: --> | ||
|
|
||
| ## Motivation and Context | ||
|
|
||
| <!--- Why is this change required? What problem does it solve? --> | ||
|
|
||
| ## How Has This Been Tested? | ||
|
|
||
| <!--- Please describe in detail how you tested your changes. --> | ||
| <!--- Include details of your testing environment, and the tests you ran to --> | ||
| <!--- see how your change affects other areas of the code, etc. --> | ||
|
|
||
| ## Screenshots or GIF (In case of UI changes): | ||
|
|
||
| ## Types of changes | ||
|
|
||
| <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
|
|
||
| - [ ] Bug fix (non-breaking change which fixes an issue) | ||
| - [ ] New feature (non-breaking change which adds functionality) | ||
| - [ ] Breaking change (fix or feature that would cause existing functionality to change) | ||
|
|
||
| ## Checklist: | ||
|
|
||
| <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
| <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
|
|
||
| - [ ] My code follows the code style of this project. | ||
| - [ ] My change requires a change to the documentation. | ||
| - [ ] I have updated the documentation accordingly. | ||
| - [ ] I have added tests to cover my changes. | ||
| - [ ] All new and existing tests passed. |