Skip to content
This repository has been archived by the owner on Feb 27, 2024. It is now read-only.

Commit

Permalink
Update readme and contribute.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jhm-ciberman committed Mar 18, 2018
1 parent 63cda59 commit 202453e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
18 changes: 11 additions & 7 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,22 @@ If you use Visual Studio Code as your editor, the project will have configured s
```bash
# Task names
# Run them from Visual Studio Code or with "npm run <task>"
test # Lint, run unit tests and generates coverage
lint # Lint the typescript code
build # Build the entire app
watch # Run the compiler in watch mode
clean # Deletes the ./dist/ and ./coverage/ folder
coverage # Generate test coverage in ./coverage/index.html
test # Lint, build and run unit tests and generates coverage
test-only # Build and Run only the unit tests
lint # Lint the typescript code
build # Build the entire app
watch # Run the compiler in watch mode
clean # Deletes the ./dist/ and ./coverage/ folder
coverage # Generate test coverage in ./coverage/index.html
integration # Builds and run the integration tests
```

If not, you can allways run `npm run watch` to start the typescript compiler for the current project directory in watch mode. (Will recompile after any change).

Also, it's recomended that you run `npm run lint` to lint the project. (`npm test` will do it automatically for you)

Also, when you finish adding your feature, please run `npm run integration` to execute the integration tests.

When you are ready, send a pull request.

If you have any question, please contact me with a pull request.
If you have any question, please contact me with a new issue.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# docs_gm

[![Greenkeeper badge](https://badges.greenkeeper.io/jhm-ciberman/docs_gm.svg)](https://greenkeeper.io/)

[![npm](https://img.shields.io/npm/dt/docs_gm.svg)](https://www.npmjs.com/package/docs_gm)
[![npm](https://img.shields.io/npm/v/npm.svg)](https://www.npmjs.com/package/docs_gm)
[![Build Status](https://travis-ci.org/jhm-ciberman/docs_gm.svg?branch=master)](https://travis-ci.org/jhm-ciberman/docs_gm)
Expand Down

0 comments on commit 202453e

Please sign in to comment.