Skip to content

docs: clarify nodejs16 requirement + fix command #1152

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

Merged
merged 2 commits into from
Nov 11, 2022
Merged

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

As detailed in #1151 there's some room for improvement when specifying the default Node version to use during development.

This PR addresses this issue as well as making the setup-local npm command more readable (housekeeping).

How to verify this change

Check the rendered version of the document.

Related issues, RFCs

Issue number: #1151

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published in downstream module
  • The PR title follows the conventional commit semantics

Breaking change checklist

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dreamorosi dreamorosi self-assigned this Nov 10, 2022
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 10, 2022
@dreamorosi
Copy link
Contributor Author

This is how it looks:

image

@dreamorosi dreamorosi linked an issue Nov 10, 2022 that may be closed by this pull request
1 task
@dreamorosi dreamorosi merged commit 8af1c17 into main Nov 11, 2022
@dreamorosi dreamorosi deleted the chore/update_setup branch November 11, 2022 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Clarify Node version in dev environment setup instructions
2 participants