Skip to content

Commit

Permalink
Added Documentation note to js-guidelines
Browse files Browse the repository at this point in the history
This references the Awesome Documentation effort. See ipfs/js-ipfs#615
  • Loading branch information
RichardLitt committed Feb 7, 2017
1 parent 607c2f2 commit ba07de4
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions js-project-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Also, remember:
- [Testing](#testing)
- [Building](#building)
- [Releasing](#releasing)
- [Documentation](#documentation)
- [Commits](#commits)
- [Commit Message Format](#commit-message-format)
- [Revert](#revert)
Expand Down Expand Up @@ -127,6 +128,10 @@ Each time a new release happens, these are the steps we follow to make sure noth
7. Push to GitHub
8. Publish to npm

### Documentation

We use [documentation.js](https://github.com/documentationjs/documentation/tree/master/docs) to document our JavaScript repositories. For each repo, we use [this gulp task](https://github.com/documentationjs/gulp-documentation). An example for how to use JSDoc to document everything can be seen in [this PR to js-ipfs](https://github.com/ipfs/js-ipfs/pull/651). Ideally, we create a `docs` folder in each repository, and make sure it is not tracked to git.

## Commits

We have very precise rules over how our git commit messages can be formatted.
Expand Down

0 comments on commit ba07de4

Please sign in to comment.