Skip to content

Commit 635c361

Browse files
achingbraindaviddias
authored andcommitted
docs: Add section about prefered dependency version strategy
1 parent 79e91da commit 635c361

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

js-code-guidelines.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Our toolkit for each of these is not set in stone, and we don't plan to halt our
1919
- [Contributing](#contributing)
2020
- [Guidelines](#guidelines)
2121
- [Linting & Code Style](#linting--code-style)
22+
- [Dependency Versions](#dependency-versions)
2223
- [Testing](#testing)
2324
- [Releasing](#releasing)
2425
- [Documentation](#documentation)
@@ -136,6 +137,10 @@ However, we've added an extra linting rule: Enforce the use of [strict mode](htt
136137

137138
Using [aegir-lint](#aegir) will help you do this easily; it automatically lints your code.
138139

140+
#### Dependency Versions
141+
142+
Our rule is: Use ~ for everything below 1.0.0 and ^ for everything above 1.0.0. If you find a package.json that is not following this rule, please submit a PR.
143+
139144
#### Testing
140145

141146
Since `js-ipfs` is meant to be both a Node.js and Browser app, we strongly recommend having tests that run in both platforms, always. For most cases, we use [mocha](http://mochajs.org) to run write the tests and [karma](http://karma-runner.github.io) to automate the test execution in the browser. This solution has been extremely convenient.

0 commit comments

Comments
 (0)