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

docs(contributing): add additional info about environment setup #5802

Merged
merged 5 commits into from
Nov 23, 2022

Conversation

benelan
Copy link
Member

@benelan benelan commented Nov 22, 2022

Related Issue: #

Summary

Designers are running into issues getting an environment set up to run the demos locally, so I'm clarifying a few things in the contributing guide.

@benelan benelan requested a review from a team as a code owner November 22, 2022 23:52
@benelan benelan added the pr ready for visual snapshots Adding this label will run visual snapshot testing. label Nov 22, 2022
@github-actions github-actions bot added docs Issues relating to documentation updates only. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels Nov 22, 2022
@benelan benelan added the pr ready for visual snapshots Adding this label will run visual snapshot testing. label Nov 22, 2022
> npm install --legacy-peer-deps
> ```
>
> Hopefully this will no longer be an issue once [`@stencil/eslint-plugin`](https://github.com/ionic-team/stencil-eslint) supports ESLint v8.
Copy link
Member Author

@benelan benelan Nov 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this looks a bit funky in source, but its noice in GH's markdown renderer

Copy link
Member

@driskull driskull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Nice! great stuff

@benelan benelan merged commit f6c6647 into master Nov 23, 2022
@benelan benelan deleted the benelan/node-setup-doc branch November 23, 2022 00:25
alisonailea pushed a commit that referenced this pull request Nov 23, 2022
**Related Issue:** #

## Summary

Designers are running into issues getting an environment set up to run
the demos locally, so I'm clarifying a few things in the contributing
guide.

<!--

Please make sure the PR title and/or commit message adheres to the
https://www.conventionalcommits.org/en/v1.0.0/ specification.

Note: If your PR only has one commit and it is NOT semantic, you will
need to either

a. add another commit and wait for the check to update
b. proceed to squash merge, but make sure the commit message is the same
as the title.

This is because of the way GitHub handles single-commit squash merges
(see zeke/semantic-pull-requests#17)

If this is component-related, please verify that:

- [ ] feature or fix has a corresponding test
- [ ] changes have been tested with demo page in Edge

---

If this is skipping an unstable test:

- include info about the test failure
- submit an unstable-test issue by
[choosing](https://github.com/Esri/calcite-components/issues/new/choose)
the unstable test template and filling it out

-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues relating to documentation updates only. pr ready for visual snapshots Adding this label will run visual snapshot testing.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants