docs(install): Add documentation for installing and running locally #300
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added documentation embracing the best practice of installing and running packages locally. This supports easier package version control both via local package.json/npm-shrinkwrap.json and is more easily compatible with third party node/npm version managers.
|
|
||
| Installing and running Commitizen locally allows you to make sure that developers are running the exact same version of Commitizen on every machine. | ||
|
|
||
| Install Commitizen with `npm i -D commitizen`. |
There was a problem hiding this comment.
For consistency I would spell it out npm install --save-dev commitizen, since you spelled it out on line 103.
There was a problem hiding this comment.
@pmcelhaney @LinusU good call. I fully support more readable documentation haha. Done.
jimthedev
added a commit
that referenced
this pull request
Dec 19, 2016
* master: docs(install): Add documentation for installing and running locally (#300) fix(tests): fix tests when a global config is present (#405) test(adapter): add test for scoped npm modules fix(adapter): add support for scoped adapters docs: Add cz-emoji to tools list (#404) feat(commit): use OS-specific cache dir for commitizen.json instead of home-or-tmp (#400) fix(npmignore): ignore more unnecessary files (#393) docs: add vscode-commitizen to tools list (#397) Ci issues with commits (#402) chore(ci): add node versions and say git version in ci docs: replace sudo mention with link to how to fix EACCES error
jimthedev
added a commit
that referenced
this pull request
Jan 2, 2017
* master: fix(package): "main" property within "package.json" (#409) style: Add linting using eslint (#406) ci(appveyor): remove appveyor on finish script ci(appveyor): disable collection of artifacts ci(tests): on windows run tests as node4/npm3 ci(travis): update semantic-release to 6.3.5 and update travis config chore(package): update nyc to version 10.0.0 (#392) docs(install): Add documentation for installing and running locally (#300) fix(tests): fix tests when a global config is present (#405) test(adapter): add test for scoped npm modules fix(adapter): add support for scoped adapters docs: Add cz-emoji to tools list (#404) feat(commit): use OS-specific cache dir for commitizen.json instead of home-or-tmp (#400) fix(npmignore): ignore more unnecessary files (#393) docs: add vscode-commitizen to tools list (#397) Ci issues with commits (#402) chore(ci): add node versions and say git version in ci docs: replace sudo mention with link to how to fix EACCES error
jimthedev
added a commit
that referenced
this pull request
Jan 2, 2017
* master: (25 commits) chore(package): update lodash to version 4.17.2 (#389) chore(package): update ghooks to version 1.3.2 (#277) chore(package): update babel-preset-stage-2 to version 6.18.0 (#371) chore(package): update babel-preset-es2015 to version 6.18.0 (#370) chore(package): update babel-cli to version 6.18.0 (#369) chore(package): update axios to version 0.15.2 (#366) chore(package): update find-node-modules to version 1.0.4 (#346) fix(package): "main" property within "package.json" (#409) style: Add linting using eslint (#406) ci(appveyor): remove appveyor on finish script ci(appveyor): disable collection of artifacts ci(tests): on windows run tests as node4/npm3 ci(travis): update semantic-release to 6.3.5 and update travis config chore(package): update nyc to version 10.0.0 (#392) docs(install): Add documentation for installing and running locally (#300) fix(tests): fix tests when a global config is present (#405) test(adapter): add test for scoped npm modules fix(adapter): add support for scoped adapters docs: Add cz-emoji to tools list (#404) feat(commit): use OS-specific cache dir for commitizen.json instead of home-or-tmp (#400) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added documentation embracing the best practice of installing and running packages locally. This
supports easier package version control both via local package.json/npm-shrinkwrap.json and is more easily compatible with third party node/npm version managers.