Thanks for the article, in particular for swagger and nvmrc, which I usually forget on my projects 😅
Next to README.md I would also add one more file on the root and is CONTRIBUTING.md. You can (and should) indeed put some short instructions on how to run the app on the main readme, but it's also nice to have a separate file with more in-depth instructions on working on the repo itself.
Details such as particular dependencies, coding standards, troubleshooting in setting up the projects... practical stuff that might not fit well in a potentially long readme.
Anyway, I see there's already one in the repo you used as a good example, which is awesome 😉
When I want to start contributing on the project is most of the time the second file I look for, right after the readme :)
Full-stack developer who loves sharing their knowledge and singing. Google Developer Expert for Web Technologies, public speaker, trainer and blogger. Writing about Web, a11y and code best practices.
Thanks for the article, in particular for swagger and nvmrc, which I usually forget on my projects 😅
Next to README.md I would also add one more file on the root and is CONTRIBUTING.md. You can (and should) indeed put some short instructions on how to run the app on the main readme, but it's also nice to have a separate file with more in-depth instructions on working on the repo itself.
Details such as particular dependencies, coding standards, troubleshooting in setting up the projects... practical stuff that might not fit well in a potentially long readme.
Anyway, I see there's already one in the repo you used as a good example, which is awesome 😉
When I want to start contributing on the project is most of the time the second file I look for, right after the readme :)
Totally agree! Good Contributing.md is essential especially in open source projects or when team works remotely.