Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added Documentation note to js-guidelines #232

Merged
merged 1 commit into from
Feb 10, 2017
Merged

Added Documentation note to js-guidelines #232

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions js-project-guidelines.md
View file
Open in desktop
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,12 @@ 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.

We use [`aegir-docs`](https://github.com/dignifiedquire/aegir) for the actual generation, which relies on JSDoc style comments. For more on aegir, see [the section below](#aegir).

## Commits

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