From d66eee96b178b49f2034fb939de7607a9944321c Mon Sep 17 00:00:00 2001 From: Aaron <79121360+UnrealApex@users.noreply.github.com> Date: Wed, 18 Aug 2021 04:33:15 -0700 Subject: Update CONTRIBUTING.md (#1735) * Renamed command line setting timer-progress bar * Added table of contents * Fixed some mistakes * More small changes * Update CONTRIBUTING.md * updated guidelines * Update CONTRIBUTING.md Note that one of the table of contents links is broken, fixing that later * Added missing sections in table of contents * Fixed typos * Fixed typos * Update CODE_OF_CONDUCT.md * Update CONTRIBUTING.md * Removed extra whitespace * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: Jack --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a2a314f49..f14670b1d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,8 +88,7 @@ The installation process of NodeJS is fairly simple, navigate to the NodeJS [web Once you have completed the above steps, you are ready to build and run Monkeytype. 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](http://localhost:5000). It will watch for changes and rebuild when you edit files in `src/` or `public/` directories. Use Ctrl+C to abort it. - - Run `firebase use {your-project-id}` if you run into any errors for this. +1. Run `npm run start:dev` to start a local dev server on [port 5000](http://localhost:5000). It will watch for changes and rebuild when you edit files in `src/` or `public/` directories. Note that rebuilding doesn't happen instantaneously so be patient for changes to appear. Use Ctrl+C to kill it. ### Standards and Guidelines @@ -117,8 +116,10 @@ Following the guidelines below will increase your chances of getting your change - Do not include swear words - Ensure that your contribution meets JSON standards (no trailing comma at the end of a list) +- Verify quotes added aren't duplicates of any already present - Verify the `length` property is correct (length of the text in characters) - Verify the `id` property is incremented correctly +- Please do not add extremely short quotes (less than 60 characters) ## Questions -- cgit v1.2.3