Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into tsdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
yinonov committed Dec 16, 2022
2 parents 8fef962 + 5af254d commit 3cbeed8
Show file tree
Hide file tree
Showing 779 changed files with 66,668 additions and 30,442 deletions.
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Editor configuration, see http://editorconfig.org
root = true

[*]
charset = utf-8
indent_style = tab
indent_size = 2
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
max_line_length = off
trim_trailing_whitespace = false
2 changes: 0 additions & 2 deletions .eslintignore

This file was deleted.

51 changes: 51 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
{
"root": true,
"ignorePatterns": ["**/*"],
"plugins": ["@nrwl/nx", "ban"],
"overrides": [
{
"files": ["*.spec.ts", "ui.test.ts"],
"rules": {
"ban/ban": [
2,
{ "name": ["describe", "only"], "message": "don't focus tests" },
{ "name": "fdescribe", "message": "don't focus tests" },
{ "name": ["it", "only"], "message": "don't focus tests" },
{ "name": "fit", "message": "don't focus tests" },
{ "name": ["test", "only"], "message": "don't focus tests" },
{ "name": "ftest", "message": "don't focus tests" }
]
}
},
{
"files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
"rules": {
"@nrwl/nx/enforce-module-boundaries": [
"error",
{
"enforceBuildableLibDependency": true,
"allow": [],
"depConstraints": [
{
"sourceTag": "*",
"onlyDependOnLibsWithTags": ["*"]
}
]
}
]
}
},
{
"files": ["*.ts", "*.tsx"],
"extends": ["plugin:@nrwl/nx/typescript"],
"rules": {
"no-console": 2
}
},
{
"files": ["*.js", "*.jsx"],
"extends": ["plugin:@nrwl/nx/javascript"],
"rules": {}
}
]
}
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.sh text eol=lf
72 changes: 52 additions & 20 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,49 @@

## What do I need to know to help?

If you are looking to help to with a code contribution our project uses [Typescript](https://www.typescriptlang.org), [Lit](https://lit.dev) and [Sass](https://sass-lang.com). If you don't feel ready to make a code contribution yet, no problem! You can also check out the [documentation issues](https://github.com/Vonage/vivid-3/labels/Type%3A%20documentation) or the [design issues](https://github.com/Vonage/vivid-3/labels/Type%3A%20Design%20%F0%9F%8E%A8) that we have.

If you are interested in making a code contribution and would like to learn more about the technologies that we use, check out the list below.

- [Vivid documentation](https://vonage.github.io/vivid-3)
- [Vivid test](https://vonage.github.io/vivid-3)
If you are interested in making a code contribution you should read our [conventions guidelines](../docs/conventions/readme.md) before you start.

## How do I make a contribution?

Never made an open source contribution before? Wondering how contributions work in the in our project? Here's a quick rundown!

1. Find an issue that you are interested in addressing or a feature that you would like to add.
2. Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under **your-GitHub-username/vivid**.
3. Clone the repository to your local machine using `git clone https://github.com/Vonage/vivid-3.git` / `gh repo clone Vonage/vivid-3`.
4. Create a new branch for your fix using `git checkout -b branch-name-here`.
5. Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
6. Use `git add insert-paths-of-changed-files-here` to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.
7. Use `git commit -m "Insert a short message of the changes made here"` to store the contents of the index with a descriptive message.
8. Push the changes to the remote repository using `git push origin branch-name-here`.
9. Submit a pull request to the upstream repository.
10. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #4352".
11. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
12. Wait for the pull request to be reviewed by a maintainer.
13. Make changes to the pull request if the reviewing maintainer recommends them.
14. Celebrate your success after your pull request is merged!
- Fork the repository and clone it to your local machine

- Create a new branch for your issue `git checkout -b branch-name-here`

- Run `npm install`

- Building and developing the documentation:
- Development: `npx nx run docs:serve` or `npm start`
- Build: `npx run build docs`

- Building and developing the components:
- Unit Tests
- `npx nx run components:test` to start the tests or `npm test`
- `npx nx run components:test --watch` to start the tests in watch mode
- `npx nx run components:test --coverage` to start the tests with coverage report (generated in the `coverage` folder)
- Visual tests: see the [ui-tests documentation](../docs/ui-tests/readme.md)
- Build: `npx nx run build components`

- Once you are done developing the change, commit your changes with a meaningful commit message

- We are using `beachball` in order to document changes:
- run: `npx beachball change` or `npm run change` . You will be prompted to describe your change. Once you do, change files will be generated and commited.
- Note that during CI a check is made to make sure this rule is followed

- Push the changes to the remote repository using `git push origin branch-name-here`.

- Submit a pull request to the upstream repository.

- Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #4352".

- In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!

- Wait for the pull request to be reviewed by a maintainer.

- Make changes to the pull request if the reviewing maintainer recommends them.

- Celebrate your success after your pull request is merged!

## Where can I go for help?

Expand All @@ -35,3 +53,17 @@ If you need help, you can ask questions on our mailing list, IRC chat, or [list
## What does the Code of Conduct mean for me?

Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code.

## Vivid criteria

### Guiding principles to consider when introducing changes

- Align to Vivid design language

- Make sure (as much as you can) contribution does not produce WCAG violations (both in design & engineering)

- Ensure user interaction with changes correspond to all types of users (e.g., keyboard, mouse, touch, assistive technology, etc.)

- Refer to components/features of valid libraries, which are compliant with UX and a11y guidelines ([Carbon](https://www.carbondesignsystem.com/components/overview/) - IBM, [Spectrum](https://spectrum.adobe.com/) - Adobe, [Material](https://material.io/components?platform=web) - Google, [Garden](https://garden.zendesk.com/) - Zendesk, [Lightning](https://www.lightningdesignsystem.com/) - Salesforce, [BBC](https://www.bbc.co.uk/gel/guidelines/category/design-patterns), etc.)

- Share UI/UX design experts' research
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

99 changes: 99 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
name: Bug report 🐛
description:
Something isn't working as expected? Here is the right place to report.
title: '[YOUR TITLE]: Brief description'
assignees:
- yonatankra, rachelbt, rinaok, yinonov
labels: ['bug']
body:
- type: markdown
attributes:
value: '## Bug report 🐛'
- type: markdown
attributes:
value: 'Use the form below to report any bugs you find. Feel free to leave blank any sections that aren’t relevant but try to include as much detail as possible. The more details we have, the faster we can respond.'
- type: textarea
id: description
attributes:
label: Description
description: "What did you expect to happen? What happened instead?"
validations:
required: true
- type: textarea
id: components
attributes:
label: Component(s) impacted
description: "Component(s) impacted? Please include screenshots, or code and relevant URLs."
validations:
required: true
- type: dropdown
id: browser
attributes:
label: Browser
description: "What browser(s) are you working in?"
multiple: true
options:
- Chrome
- Safari
- Firefox
- Microsoft Edge
- type: input
id: version
attributes:
label: Vivid Web Components version
description: "What version of Vivid Web Components are you using?"
placeholder: e.g. v2.2.8
validations:
required: true
- type: dropdown
id: severity
attributes:
label: Severity
options:
- 'Severity 1 = The design is broken in a critical way that blocks users from completing tasks or damages the brand. Affects major functionality, no workaround.'
- 'Severity 2 = Aspects of design is broken, and impedes users in a significant way, but there is a way to complete their tasks. Affects major functionality, has a workaround.'
- 'Severity 3 = The problem is visible or noticeable to users but does not impede the usability or functionality. Affects minor functionality, has a workaround.'
- 'Severity 4 = The problem is not visible to or noticeable to an average user. Affects minor functionality, no workaround needed.'
validations:
required: true
- type: input
id: application
attributes:
label: Application/website
description: "What application/website do you work on?"
validations:
required: true
- type: input
id: example-url
attributes:
label: CodeSandbox example
description:
'Use the
[codesandbox examples](https://codesandbox.io/s/amazing-haslett-tnzsn)
to help re-create the issue.'
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: "Steps to reproduce the issue (if applicable)"
- type: textarea
id: release-date
attributes:
label: "Release date (if applicable)"
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: Please confirm the following
options:
- label:
I agree to follow this project's [Code of
Conduct](https://github.com/vonage/vivid-3/blob/main/.github/CODE_OF_CONDUCT.md)
required: true
- label:
I checked the [current
issues](https://github.com/vonage/vivid-3/issues) for
duplicate issues
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Feature Request 💡
description:
Suggest a new idea for the project.
title: '[YOUR TITLE]: Brief description'
assignees:
- yonatankra, rachelbt, rinaok, yinonov
labels: ['Feature request']
body:
- type: markdown
attributes:
value: '## Feature Request 💡'
- type: textarea
id: problem
attributes:
label: The problem
description: "Provide a clear and concise description of what the problem this new feature is trying to solve. (For example, I find it frustrating when...)"
validations:
required: true
- type: textarea
id: solution
attributes:
label: The solution
description: "Provide a clear and concise description of what you would like to happen instead."
validations:
required: true
- type: input
id: application
attributes:
label: Application/website
description: "What application/website do you work on?"
validations:
required: true
- type: dropdown
id: priority
attributes:
label: Business priority
options:
- 'High Priority = pressing release'
- 'Medium Priority = upcoming release but is not pressing'
- 'Low Priority = release date is not dependent on fix or not upcoming'
validations:
required: true
- type: textarea
id: time-frame
attributes:
label: "What time frame would this ideally be needed by (if applicable)"
validations:
required: false
- type: textarea
id: user-research
attributes:
label: Examples
description: Provide sample content, references, or audits of solutions solving the same problem in other applications/websites.
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: Please confirm the following
options:
- label: I agree to follow this project's [Code of Conduct](https://github.com/vonage/vivid-3/blob/main/.github/CODE_OF_CONDUCT.md)
required: true
- label: I checked the [current issues](https://github.com/vonage/vivid-3/issues) for duplicate issues
Loading

0 comments on commit 3cbeed8

Please sign in to comment.