Skip to content

Commit

Permalink
refactor: address multiple issues, see notes
Browse files Browse the repository at this point in the history
This update address the following found issue:

1. issue markdown templates versus yml
2. content change to pull request template
3. addition ofaction workflow scripts
4. update to docs generator file to correct issue with README
5. update commitllint file type
6. remove legacy index.html file
  • Loading branch information
blackfalcon committed Feb 1, 2024
1 parent a5c828e commit bd35302
Show file tree
Hide file tree
Showing 20 changed files with 226 additions and 191 deletions.
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
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
- auro-menu
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 auro-menu you have installed
- type: markdown
attributes:
value: >
[![See it on
NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-menu?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-menu)
- type: textarea
id: details
attributes:
label: Please describe the bug
description: List out the steps to reproduce the behavior and include screenshots
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.
- type: textarea
id: exit-criteria
attributes:
label: Exit criteria
description: Define your issue's exit criteria
placeholder: "This issue can be closed once the error has been corrected. Any additional scope e.g. updates or refactors, should be discussed PRIOR to adding scope to this issue."
45 changes: 0 additions & 45 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Feature request
description: Suggest an idea for this project
title: 'auro-menu: [feature summary]'
labels:
- 'Type: Feature'
- not-reviewed
- auro-menu
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.
- type: textarea
id: exit-criteria
attributes:
label: Exit criteria
description: Define your issue's exit criteria
placeholder: "This issue can be closed once the error has been corrected. Any additional scope e.g. updates or refactors, should be discussed PRIOR to adding scope to this issue."
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/general-support.md

This file was deleted.

30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/general-support.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: General support
description: Suggestions that are not related to bugs or new features
title: 'auro-menu: [issue]'
labels:
- 'Type: Question'
- 'Type: Feature'
- not-reviewed
- auro-menu
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.
- type: textarea
id: exit-criteria
attributes:
label: Exit criteria
description: Define your issue's exit criteria
placeholder: "This issue can be closed once the error has been corrected. Any additional scope e.g. updates or refactors, should be discussed PRIOR to adding scope to this issue."
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE/release_candidate.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

**Fixes:** # (issue, if applicable)
**Resolves:** # (issue, if applicable)

## Summary:

Expand Down
2 changes: 1 addition & 1 deletion .github/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ repository:
# See https://github.com/apps/settings for app settings

# A short description of the repository that will show up on GitHub
description: Custom element that ....
description: Custom element that provides a list of options for the user to choose from

# A URL with more information about the repository
homepage: https://auro.alaskaair.com/components/auro/menu
Expand Down
58 changes: 58 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: "CodeQL"

on:
push:
branches: [ "main" ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ "main" ]

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write

strategy:
fail-fast: false
matrix:
language: [ 'javascript' ]
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support

steps:
- name: Checkout repository
uses: actions/checkout@v3

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.

# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality


# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
# - name: Autobuild
# uses: github/codeql-action/autobuild@v2

# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun

# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.

# - run: |
# echo "Run, Build Application using script"
# ./location_of_script_within_repo/buildscript.sh

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
Loading

0 comments on commit bd35302

Please sign in to comment.