Skip to content

[FIX] typos & broken link in README.md#36

Closed
Nabhag8848 wants to merge 1 commit into
RocketChat:mainfrom
Nabhag8848:readme
Closed

[FIX] typos & broken link in README.md#36
Nabhag8848 wants to merge 1 commit into
RocketChat:mainfrom
Nabhag8848:readme

Conversation

@Nabhag8848
Copy link
Copy Markdown
Contributor

Changes

  • Fix typos and broken link of developer docs in README.md

About the PR:

  • I had made same PR previously, but made mistake and push into master branch.

@samad-yar-khan
Copy link
Copy Markdown
Contributor

Hey @Nabhag8848 thanks for the contribution ! Since this PR is a little old and we recently had some additions to the ReadMe, can you please verify if anything else needs fixing ?

@Nabhag8848
Copy link
Copy Markdown
Contributor Author

Yep! sure.

@Nabhag8848
Copy link
Copy Markdown
Contributor Author

Nabhag8848 commented Feb 20, 2023

Hey @samad-yar-khan , we will need one further change in Readme, looking for your verification.

  • Currently to install dependency we have npm install but as we have package-lock.json it should be npm ci to have same dependency version for every contributor as in master branch.

  • Difference between both of them is when we install using npm ci it won't make the changes in package-lock.json as it will install the dependencies from package-lock.json and won't look at package.json.

While when we install the dependency using npm install it looks at package.json and what difference it make is:

  • Lets say we have X dependency version ^1.12.1 so here if the dependency has new minor release(s) then package-lock.json will get updated.

As per official docs: https://docs.npmjs.com/cli/v9/commands/npm-ci

Thus, we can avoid encountering the package-lock.json updated versions in contributors PR like PR #49 and ensure every contributor is on same dependency versions.

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.

2 participants