aboutsummaryrefslogtreecommitdiffhomepage
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAaron <[email protected]>2021-08-18 04:33:15 -0700
committerGitHub <[email protected]>2021-08-18 12:33:15 +0100
commitd66eee96b178b49f2034fb939de7607a9944321c (patch)
treecb35637f784d9bb39ee9e5a7f10f42201a563aa4 /CONTRIBUTING.md
parent1e1d8352285f6e8f9cd5c2a6defcecf4bef089b0 (diff)
downloadmonkeytype-d66eee96b178b49f2034fb939de7607a9944321c.tar.gz
monkeytype-d66eee96b178b49f2034fb939de7607a9944321c.zip
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 <[email protected]>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md5
1 files changed, 3 insertions, 2 deletions
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 <kbd>Ctrl+C</kbd> 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 <kbd>Ctrl+C</kbd> 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