Commit dd85a17

author

Federico Moyá

authored

Update README.md

1 parent 102820c commit dd85a17Copy full SHA for dd85a17

File tree

+10

-0

lines changed

+10

-0

lines changed

Lines changed: 10 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -13,6 +13,16 @@ Depending on your `SimpleCoV`'s settings you will experiment different outcomes.
`13`	`13`	- If you configure `SimpleCov` to run with `branch` coverage you should expect an output formatted like [sample_with_branch.json](https://github.com/fede-moya/simplecov_json_formatter/blob/master/spec/fixtures/sample_with_branch.json)
`14`	`14`	`- Otherwise you should expect an output formatted like [sample.json](https://github.com/fede-moya/simplecov_json_formatter/blob/master/spec/fixtures/sample.json)`
`15`	`15`
	`16`	`+## Development`
	`17`	`+`
	`18`	+We encourage you to use docker for common operations like running tests, or debugging your code. Running `make sh` will run a new container instance based on the `Dockerfile` provided at root, finally a shell prompt will be displayed on your terminal. Also, syncronization with your local files will be already set.
	`19`	`+### Tests`
	`20`	+`make test` will trigger the excution of both running tests and running rubocop as linter a check, by simply running `rake`, this actions will be run inside a new container but using your local files.
	`21`	`+`
	`22`	`+### Format`
	`23`	`+`
	`24`	+`make format` will run `rubocop -a` which stands for _autocorrect_ and format your code according to the `.rubocop.yml` config file.
	`25`	`+`
`16`	`26`	`## Copyright`
`17`	`27`
`18`	`28`	`See License ?`

Comments

(0)