Skip to content

Commit

Permalink
fix: update issue templates and settings yml at template
Browse files Browse the repository at this point in the history
Change to be Committed:
modified: template/.github/settings.yml
newfile: template/.github/ISSUE_TEMPLATE/bug_report.yml
newfile: template/.github/ISSUE_TEMPLATE/feature_request.yml
newfile: template/.github/ISSUE_TEMPLATE/general-support.yml
deleted: template/.github/ISSUE_TEMPLATE/bug_report.md
deleted: template/.github/ISSUE_TEMPLATE/feature_request.md
deleted: template/.github/ISSUE_TEMPLATE/general-support.md
  • Loading branch information
irma-kurnia-phtn committed Apr 25, 2023
1 parent 0106481 commit 3404ac4
Show file tree
Hide file tree
Showing 7 changed files with 173 additions and 134 deletions.
57 changes: 0 additions & 57 deletions template/.github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

56 changes: 56 additions & 0 deletions template/.github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Bug report
description: Create a report to help us improve
title: '[issue summary] Please verify version before submitting new issue'
labels:
- 'Type: Bug'
- not-reviewed
- '[namespace]-[name]'
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
id: version
attributes:
label: Please verify the version of [namespace]-[name] you have installed
- type: markdown
attributes:
value: >
[![See it on
NPM!](https://img.shields.io/npm/v/@alaskaairux/[namespace]-[name]?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@alaskaairux/[namespace]-[name])
- type: textarea
id: details
attributes:
label: Please describe the bug
description: List out the steps to reproduce the behavior
placeholder: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error
- type: dropdown
id: repro
attributes:
label: Reproducing the error
description: Are you able to reproduce this issue on the [Auro docsite](https://auro.alaskaair.com/)?
options:
- This issue is reproducible on the Auro docsite
- This issue cannot be reproduced on the Auro docsite
- type: textarea
id: expected
attributes:
label: Expected behavior
description: Please add a clear and concise description of what you expected to
happen.
- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context about the problem here.
29 changes: 0 additions & 29 deletions template/.github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

29 changes: 29 additions & 0 deletions template/.github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Feature request
description: Suggest an idea for this project
title: '[namespace]-[name]: [feature summary]'
labels:
- 'Type: Feature'
- not-reviewed
- '[namespace]-[name]'
body:
- type: textarea
id: request
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is.
placeholder: Ex. I'm always frustrated when [...]
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
- type: textarea
id: alternative
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
33 changes: 0 additions & 33 deletions template/.github/ISSUE_TEMPLATE/general-support.md

This file was deleted.

24 changes: 24 additions & 0 deletions template/.github/ISSUE_TEMPLATE/general-support.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: General support
description: Suggestions that are not related to bugs or new features
title: '[namespace]-[name]: [issue]'
labels:
- 'Type: Question'
- 'Type: Feature'
- not-reviewed
- '[namespace]-[name]'
body:
- type: textarea
id: request
attributes:
label: General Support Request
description: A clear and concise description of what you are interested in seeing.
- type: textarea
id: solution
attributes:
label: Possible Solution
description: Not obligatory, but suggest an idea of how to implement the requested update.
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
79 changes: 64 additions & 15 deletions template/.github/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ branches:
dismiss_stale_reviews: true
# Blocks merge until code owners have reviewed.
require_code_owner_reviews: true
# Required. Require status checks to pass before merging. Set to null to disable
# Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.
dismissal_restrictions:
users: ["blackfalcon"]
Expand All @@ -71,59 +72,107 @@ branches:
labels:
- name: [namespace]-[name]
cat: default
color: fa23e4
color: 'fa23e4'
description:
process: Key filter for this repo
- name: duplicate
color: '156fad'
description: This Issue or Pull Request already exists
- name: good first issue
color: '6bb7fb'
description: Good for newcomers
aliases:
- beginner-friendly
- beginner
- good-starter-issue
- good for beginner
- Good for beginners
- starter-issue
- starter
- name: help wanted
color: '6bb7fb'
description: Extra attention is needed, this user requires assistance to complete
the work
- name: not-reviewed
color: '000000'
description: This issue has not yet been reviewed by the Auro team
- name: released
color: 'A9A9A9'
description: Completed work has been released
- name: 'Status: help wanted'
color: '2492eb'
description: Team is asking for assistance to complete the work
- name: 'Status: Work In Progress'
description: Issue or Pull Request work is in Progress
color: 'c0e585'
- name: 'Status: Review Needed'
color: 'c0e585'
description: Work is completed, user is requesting feedback
- name: 'Status: Complete'
color: 'c0e585'
description: Owner has completed work and considers it ready to be merged
- name: 'Status: Blocked'
color: 'df0b37'
description: Progress on the issue is blocked, immediate attention is required
description: Progress on the issue is Blocked, immediate attention is required
aliases:
- blocked
- name: 'Status: Abandoned'
color: '156fad'
description: The issue or Pull Request is wont-fix
description: The author of this issue or Pull Request is not responding
aliases:
- wontfix
- invalid
- name: 'Type: Spike'
color: 'ab33d6'
description: Team requires further research or investigation
- name: 'Type: Bug'
color: 'df0b37'
color: df0b37
description: Bug or Bug fixes
aliases:
- bug
- name: 'Type: Feature'
color: 'e5ad07'
color: 'ffd200'
description: New Feature
aliases:
- enhancement
- name: 'Type: Design'
color: 'e5ad07'
color: 'ffd200'
description: New or related Design work
aliases:
- enhancement
- name: 'Type: Testing'
color: 'fff0cd'
description: Test maintenance and support
- name: 'Type: Content'
color: 'ffd200'
description: Adding or editing content
aliases:
- test
- testing
- enhancement
- name: 'Type: Refactoring'
color: 'ffd200'
description: A code change that neither fixes a bug nor adds a feature
aliases:
- refactor
- name: 'Type: Documentation'
color: 'f26135'
color: 'ffd200'
description: Documentation only changes
aliases:
- documents
- document
- name: 'Type: CI'
color: 'ffd200'
description: Changes to CI configuration files and scripts
aliases:
- ci
- name: 'Type: Perf'
color: 'ffd200'
description: Performance update to existing code
- name: 'Question'
color: 'b83302'
description: Further information is requested
aliases:
- question
- name: 'Type: Dependencies'
color: 'ffd200'
description: Pull requests that update a dependency file
aliases:
- dependencies
- name: 'Type: UI Update'
color: 'ffd200'
description: Changes to the user interface
aliases:
- dependencies

0 comments on commit 3404ac4

Please sign in to comment.