Thanks you for considering a contribution to Microcosm!
Microcosm is built using tools written for
nodejs. We recommend installing Node with
nvm. Dependencies are managed
through package.json
.
You can install dependencies with:
npm install
npm test
For test coverage:
npm run test:cov
open ./coverage/index.html
Be sure to check the ./coverage
folder to verify all code paths are
touched.
The following steps are required to push a new release:
- Update changelog
npm version <major,minor,patch>
git push --tags
make release
Microcosm must first be compiled down to ES5 using Babel. The following command will perform that task and deploy to NPM:
make release
For release candidates, consider deploying to NPM using the beta
tag
with:
make prerelease
Consider master unsafe, use npm
for the latest stable version.
Microcosm uses ES6 Javascript (compiled using Babel). As for style, shoot for:
- No semicolons
- Commas last,
- 2 spaces for indentation (no tabs)
- Prefer ' over ", use string interpolation
- 80 character line length
All changes should be submitted through pull request. Ideally, at least two 👍s should be given before a pull request is merge.