EddieHubCommunity
[DOCS] Adding clearer commit instructions
Description
I noticed in many of the pull requests contributors often commit a changed package-lock.json file since it is changed after running npm. An instruction could be added to the readme to push just the users json file.
Screenshots
Additional information
No response
It's great having you contribute to this project
Welcome to the community :nerd_face:If you would like to continue contributing to open source and would like to do it with an awesome inclusive community, you should join our Discord chat and our GitHub Organisation - we help and encourage each other to contribute to open source little and often 🤓 . Any questions let us know.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hey @ChinmayMhatre, That's true that many folks commit dependencies files!
But this is because they Don't Read Docs, because it's clearly mentioned in the Contributing.md to not to commit package-lock.json.
Also, in the Readme.md it's mention to run npm ci instead of npm install to prevent changes in package-lock.json, but still, some PRs need to revert those!!
⚠ We value your time and contribution but I think this will not work, feel free to put your opinion on this, or you can close this issue! 🙂
Supportive images
Umm.. I think if it is a repeating issue. Putting a note in the readme would make it easier for the reviewers as well.
That's fine, but since it's already mentioned to run npm ci, there will be no changes in lock file, if they read Readme. So I don't think there is a need for this!!
Let's see what other maintainers think on this! CC @EmmaDawsonDev
I looked at the reviewpad.yml file and got an idea. I saw there is already a rule to check if only one file is added. We could use that to give out a automated message containing the instructions when more than one file is changed or added.
Thank you for the collaboration 👍
We have improved the documentation, so I think this is solved now - if anything is missing please raise a new issue https://linkfree.eddiehub.io/docs
