From b326bf989a6583e31dba81391b952b7fe71a1d2c Mon Sep 17 00:00:00 2001 From: Hamish Willee Date: Fri, 13 Feb 2026 16:24:30 +1100 Subject: [PATCH] Update README with contributing section to explain testing Added contributing guidelines and clarified database usage. --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e2505725..9fbb3e67 100644 --- a/README.md +++ b/README.md @@ -22,15 +22,31 @@ To get this project up and running locally on your computer: ```bash npm install ``` + 3. Run the tutorial server, using the appropriate command line shell for your environment: ```bash # Linux terminal DEBUG=express-locallibrary-tutorial:* npm run devstart - + # Windows Powershell $ENV:DEBUG = "express-locallibrary-tutorial:*"; npm start ``` + 4. Open a browser to to open the library site. -> **Note:** The library uses a default MongoDB database hosted on [MongoDB Atlas](https://www.mongodb.com/cloud/atlas). You should use a different database for your own code experiments. +> [!NOTE] +> The library uses a default MongoDB database hosted on [MongoDB Atlas](https://www.mongodb.com/cloud/atlas). +> You should use a different database for your own code experiments. + +## Contributing + +The project is the result of carefully running through all the steps in the [tutorial on MDN](https://developer.mozilla.org/en-US/docs/Learn/Server-side/Express_Nodejs/Tutorial_local_library_website). +Any changes to either MDN or this project must be synchronized. +Generally it is better to implement changes here before submitting them to MDN. + +Before submitting a PR, make sure that the tests pass: + +```bash +npm test +```