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

fix: specify range of node versions in readme and advise cd into package #535

Merged
merged 2 commits into from
Feb 14, 2024

Conversation

jordaniza
Copy link
Contributor

@jordaniza jordaniza commented Feb 12, 2024

Description

Changes in the package README files for new contributors. Full
details here

Warn users about certain node versions:

I decided to avoid an .nvmrc or any package.json engines because dependencies may be updated shortly and I don't want to break downstream users CI pipelines. A readme will suffice for now

Task ID: OS-1036

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I ran all tests with success and extended them if necessary.
  • I have updated the CHANGELOG.md file in the root folder.
  • I have updated the DEPLOYMENT_CHECKLIST file in the root folder.
  • I have updated the UPDATE_CHECKLIST file in the root folder.

@CLAassistant
Copy link

CLAassistant commented Feb 12, 2024

CLA assistant check
All committers have signed the CLA.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Rekard0 Rekard0 merged commit 54b8f37 into develop Feb 14, 2024
2 checks passed
@Rekard0 Rekard0 deleted the fix/readme-updates branch February 14, 2024 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants