Skip to content

Commit

Permalink
chore: add js documentation contributing guidelines (#474)
Browse files Browse the repository at this point in the history
  • Loading branch information
vasco-santos authored Dec 18, 2020
1 parent eeeaaaf commit e0812a3
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING_JS.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,9 @@ For releasing a js-ipfs, see [RELEASE_ISSUE_TEMPLATE](https://github.com/ipfs/js

#### Documentation

`TBW`
Documentation will be generated automatically by the JSDoc based TS types in the codebase.

Type definitions and type imports should be created on the top of any JS file (below eventual requires needed). For tooling instructions and best practices, see [Documentation for JSDoc based TS types](https://github.com/ipfs/aegir/blob/master/md/ts-jsdoc.md).

### Commits

Expand Down

0 comments on commit e0812a3

Please sign in to comment.