Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1.0 rc #27

Merged
merged 28 commits into from
Jul 18, 2023
Merged
Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
d2d0c08
Newly generated repo commit
cynthiaricomendoza-alaskaair May 11, 2023
b63188e
build(CODEOWNERS): add innersource reviewers #3
cynthiaricomendoza-alaskaair May 11, 2023
8ce8360
chore(generateDocs): remove superfluous code #7
DZwell May 19, 2023
d403096
feat(ux/ui): build of component #5
cynthiaricomendoza-alaskaair May 16, 2023
9dee19c
feat: add close button #10
cynthiaricomendoza-alaskaair May 25, 2023
7f1d6b6
feat: placement of toast on UI #14
cynthiaricomendoza-alaskaair May 25, 2023
36a8218
feat: support type property #8
cynthiaricomendoza-alaskaair May 22, 2023
91a847e
feat(ux/ui): hide toast after five seconds #13
cynthiaricomendoza-alaskaair May 16, 2023
4f3823d
feat(ux/ui): implement toaster #19
cynthiaricomendoza-alaskaair Jun 1, 2023
e5d6f55
feat(ux/ui): support noIcon property #9
cynthiaricomendoza-alaskaair Jun 8, 2023
1b4f1ff
feat: do not auto-dismiss error toast #26
cynthiaricomendoza-alaskaair Jun 15, 2023
0469692
perf(mobile): allow greater touch surface #22
cynthiaricomendoza-alaskaair Jun 15, 2023
6790c67
chore(deps): remove unused dependency
cynthiaricomendoza-alaskaair Jun 22, 2023
baf2b29
docs(api): add property examples
cynthiaricomendoza-alaskaair Jun 23, 2023
27e08d7
docs(readme): cleanup dynamic toasts & custom element
cynthiaricomendoza-alaskaair Jun 23, 2023
f0a3bcb
refactor(style): cleanup toast classes
cynthiaricomendoza-alaskaair Jun 23, 2023
b41f313
perf(demo): create api.html file
cynthiaricomendoza-alaskaair Jun 26, 2023
7df2872
perf(screenreader): notify when toast is visible
cynthiaricomendoza-alaskaair Jun 30, 2023
850a63b
docs(api): add missing scripts
cynthiaricomendoza-alaskaair Jun 30, 2023
e92a4c8
docs(readme): add script for toaster
cynthiaricomendoza-alaskaair Jul 3, 2023
b1a093d
docs(*): update demo and example docs
blackfalcon Jul 6, 2023
5fc961e
docs(jsdoc): update function description
blackfalcon Jul 6, 2023
d67803b
fix(lit): update template to import from correct ref
blackfalcon Jul 6, 2023
a6d08ba
chore(settings): update element description
blackfalcon Jul 6, 2023
9d12510
docs(issues): delete deprecated versions of issue templates
blackfalcon Jul 6, 2023
22236d7
ci(config): add auto assign issue yml
blackfalcon Jul 17, 2023
41a444d
chore: use new example.js model
cynthiaricomendoza-alaskaair Jul 17, 2023
295268d
docs(api): add showToast() in all examples
cynthiaricomendoza-alaskaair Jul 18, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@
# If a pull request touches any files in the ./src dir, only these owners
# will be requested to review.
./src/* @AlaskaAirlines/auroteamreviewers
./src/* @AlaskaAirlines/AuroToastInnersourceReviewers
25 changes: 16 additions & 9 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,34 @@ Feature requests stem from a business need. It is important to understand whethe

A bug is defined by: _"A demonstrable problem that is caused by a file in the repository."_ Good bug reports are extremely helpful - thank you!

To submit an issue, please go to [Auro's project status board](https://auro.alaskaair.com/component-status) and click on the ISSUES badge associated to project you wish to submit an issue for.
To submit an issue, please go to [Auro's project status board](https://auro.alaskaair.com/component-status) and click on the ISSUES badge associated to project you wish to submit an issue for, or click on the GITHUB ISSUES icon at the top of every element's page in the Auro doc site.

Guidelines for bug reports:

1. Check if the issue has already been reported. Go to Auro's [project board](https://github.com/orgs/AlaskaAirlines/projects/1) and click on labels like `type: bug` or `type: feature` to filter through the many issues between all of Auro's projects.
* For bugs - [https://github.com/orgs/AlaskaAirlines/projects/1?card_filter_query=label%3A%22type%3A+bug%22](https://github.com/orgs/AlaskaAirlines/projects/1?card_filter_query=label%3A%22type%3A+bug%22)
* For features - [https://github.com/orgs/AlaskaAirlines/projects/1?card_filter_query=label%3A%22type%3A+feature%22](https://github.com/orgs/AlaskaAirlines/projects/1?card_filter_query=label%3A%22type%3A+feature%22)
1. BEFORE submitting an issue, make sure that you are **using the latest version** of the component you are working with and/or see if you can reproduce the error in the Auro doc site.
1. Check if the issue has already been reported. Go to any Auro repo's issue page and use Github's search features to see if a similar issue has been submitted.
1. Check if the issue has been fixed — try to reproduce it using the latest main or feature branch in the repository
1. Isolate the problem — ideally create a reduced test case and a live example

Please allow up to 48 hours to receive a response from the Auro team post issue submission.

A good bug report shouldn't leave others needing to follow up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Poor bug reports will be closed as the team is unable to reproduce the issue.

For more information about the issue submission process, please see the [Issues: work status label maintenance](https://auro.alaskaair.com/contributing/issues-prs-labels) section of the Auro contributing guidelines
PLEASE be responsive to questions asked via the issue's comments. All attempts to communicate to the author of the issue will be made. If the author is unresponsive, the issue will be labeled as `abandoned` and will be closed upon next review.

Please **DO NOT** start any work on a potential pull request until you have consulted with a member of the Auro team per your issue. This brief consultation, facilitated via the issue and its related comments, will help ensure the success of your pull request submission.

## Submitting pull requests

No one other than repository managers have direct access to any repository. For non-team members, pull requests must originate from a [forked repo](https://auro.alaskaair.com/contributing/upstream) in your own Github account.

All new work that is to be considered for merging with the `main` branch must start from a new feature branch of work. This feature branch should be in response to either a [reported bug](https://github.com/orgs/AlaskaAirlines/projects/1?card_filter_query=label%3A%22type%3A+bug%22) or a [new business requirement](https://github.com/orgs/AlaskaAirlines/projects/1?card_filter_query=label%3A%22type%3A+feature%22).
All new work that is to be considered for merging with the `main` branch must start from a new feature branch of work. This feature branch should be in response to either a [reported bug](https://auro.alaskaair.com/bugs) or a [requested features](https://auro.alaskaair.com/help-wanted).

Unsolicited pull requests **will take longer** to respond to. We ask for your patience. To help expedite any pull request, we ask that you **submit an issue first**. This will help the team understand the problem you are trying to solve before submitting the solution.

For more information about the pull request submission process, please see the [Pull Requests](https://auro.alaskaair.com/contributing/issues-prs-labels) section of the Auro contributing guidelines
To assist with the pull request review, it is also recommended that you **DO NOT** do any work until you have consulted with member of the Auro team. This process will be facilitated via the issue and its related comments. Once an issue is submitted, please allow up to 48 hours to receive a response from the Auro team post issue submission.

### Feature branch naming

Expand All @@ -44,6 +47,10 @@ The name of the feature branch should be descriptive as to the nature of the wor
jdoe/cleanUpNpmApi/#80
```

## DO NOT git pull on a feature branch

We ask that we keep our repo's history linear. This helps maintain a easy to understand version history and is crucial to our semantic versioning strategy. If you find yourself unable to push to the remote, please **DO NOT* use the `$ git pull` command. If this is discovered during a review, the pull request will be rejected. Please see the following instructions on rebasing below.

### Rebase on main

To maintain repository history health, it is best practice to [rebase branches off of an updated main versus merging down](https://www.atlassian.com/git/tutorials/merging-vs-rebasing).
Expand Down Expand Up @@ -104,13 +111,13 @@ fix(pencil): stop graphite breaking when too much pressure applied #80
| docs | Documentation only changes |
| feat | A new feature (this correlates with `MINOR` in semantic versioning) |
| fix | A bug fix (this correlates with `PATCH` in semantic versioning) |
| perf | A code change that improves performance |
| perf | A code change that improves performance (this correlates with `PATCH` in semantic versioning) |
| BREAKING CHANGE | A code change that is not backwards compatible (correlating with `MAJOR` in semantic versioning) |
| refactor | A code change that neither fixes a bug nor adds a feature |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| test | Adding missing tests or correcting existing tests |

It is considered best practice to group multiple commits into a release. For a versioned update, be sure that your series of commits include either `feat` or `fix`. For a `MAJOR` release, any commit can be accompanied by a `BREAKING CHANGE` comment.
It is considered best practice to group multiple commits into a release. For a versioned update, be sure that your series of commits include either `feat`, `fix` or `perf`. For a `MAJOR` release, any commit can be accompanied by a `BREAKING CHANGE` comment as illustrated above.

## Git commit messages

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/blueprint.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Component Blueprint
about: Checklist for releasing a new component blueprint
title: '[Component Blueprint]'
labels: '[namespace]-[name], Type: Design, not-reviewed'
labels: 'auro-toast, Type: Design, not-reviewed'
assignees: leeejune
---

Expand Down
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-toast'
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-toast you have installed
- type: markdown
attributes:
value: >
[![See it on
NPM!](https://img.shields.io/npm/v/@alaskaairux/auro-toast?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@alaskaairux/auro-toast)
- 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."
29 changes: 29 additions & 0 deletions .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: 'auro-toast: [feature summary]'
labels:
- 'Type: Feature'
- not-reviewed
- 'auro-toast'
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.
24 changes: 24 additions & 0 deletions .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: 'auro-toast: [issue]'
labels:
- 'Type: Question'
- 'Type: Feature'
- not-reviewed
- 'auro-toast'
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.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/publish_component.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: Publish Component
about: Create a ticket to drive compliance before publishing a new component to Auro Design System
title: 'auro-template; publish to Auro Design System'
labels: 'Status: Review Needed, not-reviewed'
title: 'Publish to Auro Design System'
labels: 'auro-toast, not-reviewed'
---

# Publish Component
Expand Down Expand Up @@ -53,7 +53,7 @@ labels: 'Status: Review Needed, not-reviewed'
- [ ] All work is reviewed by Auro team
1. __Publishing__
- [ ] Removed all references to `auroLabs` from the repository
- [ ] Component properly named, e.g. `auro-template`
- [ ] Component properly named, e.g. `auro-toast`
- [ ] GitHub Repository properly named
- Updated `readme.md`
- [ ] Install information updated to published namespace
Expand Down
Loading