From 22b29aeea753fd91155ff9ae0c3728dd7cd4fbdd Mon Sep 17 00:00:00 2001 From: UnrealApex <79121360+UnrealApex@users.noreply.github.com> Date: Tue, 29 Jun 2021 07:59:46 -0700 Subject: [PATCH] Updated CONTRIBUTING.md (#1577) * Renamed command line setting timer-progress bar * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Fixed wrong keyboard shortcut for mac --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5198d52b6..0f9348218 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,14 +49,16 @@ - Select default location and enable ## Building and Running + 1. Run `npm install` in the project root directory to install dependencies. -1. Run `npm run start:dev` to start a local dev server on port 5000. It will watch for changes and rebuild when you edit files in `src/` or `public/`. Use ctrl+c to stop it. - - Run `firebase use ` if you run into any errors for this. +1. Run `npm run start:dev` to start a local dev server on port 5000. It will watch for changes and rebuild when you edit files in `src/` or `public/` directories. Use control c to abort it. + - Run `firebase use {your-project-id}` if you run into any errors for this. ## Standards and Conventions 1. Code style is enforced by [Prettier](https://prettier.io/docs/en/install.html), which is automatically ran every time you `git commit` (if you've followed the above instructions properly). +1. If you are unsure of the best practices and conventions of Javascript, please take a look at the [JavaScript Best Practices](https://www.w3schools.com/js/js_best_practices.asp) and [JavaScript Coding Conventions](https://www.w3schools.com/js/js_conventions.asp) ## Questions