-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #49 from SchweizerischeBundesbahnen/issue_templates
Issue templates
- Loading branch information
Showing
5 changed files
with
267 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,108 @@ | ||
| name: Bug Report | ||
| description: File a bug report | ||
| title: "[Bug]: " | ||
| labels: ["bug", "triage"] | ||
| assignees: | ||
| - octocat | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| # Thanks for taking the time to fill out this bug report! | ||
| ## Preflight Checklist | ||
| - type: checkboxes | ||
| id: preflight-checklist | ||
| attributes: | ||
| label: Preflight Checklist | ||
| options: | ||
| - label: I have read the [Contributing Guidelines](https://github.com/SchweizerischeBundesbahnen/design_system_flutter/blob/main/Contributing.md) for this project. | ||
| required: true | ||
| - label: I have searched the [issue tracker](https://github.com/...) for an issue that matches the one I want to file, without success. | ||
| required: true | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## General Information | ||
| - type: dropdown | ||
| id: bug-type | ||
| attributes: | ||
| label: Bug type | ||
| options: | ||
| - 'Functionality' | ||
| - 'Accessibility' | ||
| - 'Performance' | ||
| - 'Security vulnerability' | ||
| - 'Other' | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: repository | ||
| attributes: | ||
| label: It affects the following repositories | ||
| options: | ||
| - 'Flutter' | ||
| - 'Swift' | ||
| - 'Both' | ||
| - 'Other' | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: platform | ||
| attributes: | ||
| label: It affects the following platform (only for flutter) | ||
| options: | ||
| - 'Web' | ||
| - 'Native' | ||
| - 'Both' | ||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: Which release are you using | ||
| description: e.g. 0.7.2 | ||
| validations: | ||
| required: false | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Environment | ||
| - type: input | ||
| id: additional-settings | ||
| attributes: | ||
| label: Additional settings | ||
| description: e.g. save data active | ||
| validations: | ||
| required: false | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Detailed description | ||
| - type: textarea | ||
| id: what-happened | ||
| attributes: | ||
| label: What happened? | ||
| description: Also tell us, what did you expect to happen? | ||
| placeholder: Tell us what you see! | ||
| value: | | ||
| Describe in detail the issue you are having. | ||
| What did you expect to happen? What happened instead? What would you like to see changed? | ||
| Is the issue related to a specific component? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: steps | ||
| attributes: | ||
| label: Steps to reproduce the issue | ||
| description: Also tell us, what did you expect to happen? | ||
| placeholder: Tell us what you see! | ||
| value: | | ||
| 1. Step one | ||
| 2. Step two | ||
| 3. ... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Relevant log output | ||
| description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
| render: shell |
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 @@ | ||
| {} |
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,61 @@ | ||
| name: Request for contributing | ||
| description: Request for contributing a new component or enhancement of a component | ||
| title: "[Contributing request]: " | ||
| labels: ['type: contributing-request'] | ||
| assignees: | ||
| - octocat | ||
| body: | ||
| - type: checkboxes | ||
| id: preflight-checklist | ||
| attributes: | ||
| label: Preflight Checklist | ||
| options: | ||
| - label: I have read the [Contributing Guidelines](https://github.com/SchweizerischeBundesbahnen/design_system_flutter/blob/main/Contributing.md) for this project. | ||
| required: true | ||
| - label: I have searched the [issue tracker](https://github.com/orgs/...) for an issue that matches the one I want to file, without success. | ||
| required: true | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Please describe your idea in as much detail as possible. | ||
| - type: dropdown | ||
| id: new-or-enhancement | ||
| attributes: | ||
| label: Contribution type | ||
| options: | ||
| - 'Contribute a new component' | ||
| - 'Contribute an enhancement of a component' | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: feature-description | ||
| attributes: | ||
| label: Feature Description | ||
| description: For what purpose is the component used? What features does it need to have? Which component should be enhanced? | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: link | ||
| attributes: | ||
| label: Link to design proposal file | ||
| description: Figma-Link | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: api-proposal | ||
| attributes: | ||
| label: Please describe the required properties (with type and value) for the component | ||
| value: | | ||
| Example: | ||
| variant (string): "primary" | "secondary" | "translucent" | "transparent" | ||
| size (string): "s" | "m" | "l" | ||
| - type: textarea | ||
| id: markup-proposal | ||
| attributes: | ||
| label: Please send a proposal for a dart or swift markup | ||
| value: | | ||
| Example: | ||
| <sbb-button> | ||
| <sbb-icon slot="icon" name="info"></sbb-icon> | ||
| Label | ||
| </sbb-button> |
43 changes: 43 additions & 0 deletions
43
.github/ISSUE_TEMPLATE/feature-request-or-enhancement-mobile.yml
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 @@ | ||
| name: Feature request or enhancement | ||
| description: Request for a new component or enhancement of a component | ||
| title: "[Feature request]: " | ||
| labels: ['type: feature-request'] | ||
| assignees: | ||
| - octocat | ||
| body: | ||
| - type: checkboxes | ||
| id: preflight-checklist | ||
| attributes: | ||
| label: Preflight Checklist | ||
| options: | ||
| - label: I have read the [Contributing Guidelines](https://github.com/SchweizerischeBundesbahnen/design_system_flutter/blob/main/Contributing.md) for this project. | ||
| required: true | ||
| - label: I have searched the [issue tracker](https://github.com/orgs/...) for an issue that matches the one I want to file, without success. | ||
| required: true | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Please describe your idea in as much detail as possible. | ||
| - type: dropdown | ||
| id: new-or-enhancement | ||
| attributes: | ||
| label: Request type | ||
| options: | ||
| - 'Request for a new component' | ||
| - 'Request for enhancement of a component' | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: request | ||
| attributes: | ||
| label: Functionality | ||
| description: For what purpose is the component used? What features does it need to have? Which component should be enhanced? | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: link | ||
| attributes: | ||
| label: Link to design proposal file | ||
| description: Figma-Link | ||
| validations: | ||
| required: false |
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,54 @@ | ||
| name: Question | ||
| description: Ask a question to our developers and user experience architects | ||
| title: "[Question]: " | ||
| labels: ['type: question'] | ||
| assignees: | ||
| - octocat | ||
| body: | ||
| - type: checkboxes | ||
| id: preflight-checklist | ||
| attributes: | ||
| label: Preflight Checklist | ||
| options: | ||
| - label: I have read the [Contributing Guidelines](https://github.com/SchweizerischeBundesbahnen/design_system_flutter/blob/main/Contributing.md) for this project. | ||
| required: true | ||
| - label: I have searched the [issue tracker](https://github.com/...) for an issue that matches the one I want to file, without success. | ||
| required: true | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Your question | ||
| - type: dropdown | ||
| id: repository | ||
| attributes: | ||
| label: It affects the following repositories | ||
| options: | ||
| - 'Flutter' | ||
| - 'Swift' | ||
| - 'Both' | ||
| - 'Other' | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: question | ||
| attributes: | ||
| label: Your Question | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: relevant-information | ||
| attributes: | ||
| label: Give us a summary about your question | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: additional-information | ||
| attributes: | ||
| label: Provide as much useful information as you can | ||
| description: e.g. Links to Figma or other references | ||
| validations: | ||
| required: false | ||
|
|
||
|
|
||
|
|
||
|
|