Skip to content

Commit

Permalink
Fix typos in CONTRIBUTING.md (#454)
Browse files Browse the repository at this point in the history
  • Loading branch information
Leon Si authored May 15, 2022
1 parent eefc93b commit 48cf4fe
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@

# Guidelines
* Modules must not depend on any other npm modules (inlcuding other just modules)
* Modules must not depend on any other npm modules (including other just modules)
* Always assume Just modules will be used in hot code and code accordingly
* Write in ES5
* Favor `for` loops over high order functions
* Don't repeatedly access the same property, assign it to a `var`
* Brevity
* A lot of people choose Just utilities to minimize their app's JS footprint in memory/network constrained environments
* Keep it brief and don't add redundant code. Most utilites should fit into one shortish function.
* Keep it brief and don't add redundant code. Most utilities should fit into one shortish function.
* API
* Keep the API simple and intuitive
* Avoid multiple arguments or option arguments whenever possible–-make it just do one thing
* Tests
* Write a test for each use case
* At a minimim, include tests for each example you included in the README
* At a minimum, include tests for each example you included in the README
* Too thorough is better than not thorough enough
* TypeScript
* We're in the process of adding typescript defintions (`index.d.ts`) and tests (`index.tests.ts`) for every utility
* We're in the process of adding typescript definitions (`index.d.ts`) and tests (`index.tests.ts`) for every utility
* Please add these files for your new utility if you feel comfortable doing so. [Here's](https://github.com/angus-c/just/pull/247/files) an example PR.
* Also add `"types": "index.d.ts"` after `main` entry in package.json.
* You can verify new TypeScript definitions by running `yarn test-types` (This also gets run as part of the `yarn test` script)
Expand All @@ -26,7 +26,7 @@
# README template
* Thanks to [Max Synnott](https://github.com/maxsynnott), local and global READMEs are now autogenerated from a template.
* Add a new section to [md-variables.com](https://github.com/angus-c/just/blob/master/md-variables.json) for your package:
* root key: the `name` value from your `package.json` (e.g. `just-comapct`)
* root key: the `name` value from your `package.json` (e.g. `just-compact`)
* `packageName`: same as root key
* `dir`: the directory you wrote your package in (e.g. `array-compact`)
* `description`: a one sentence description of what the utility does (for line breaks use an array of strings)
Expand Down

0 comments on commit 48cf4fe

Please sign in to comment.