Skip to content

Commit b02c386

Browse files
author
Vishal.Vaibhav
committed
more updated readme
1 parent 25e277e commit b02c386

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
[![Build Status](https://vela-server.prod.target.com/badge/TargetOSS/pull-request-code-coverage/status.svg)](https://vela.prod.target.com/TargetOSS/pull-request-code-coverage)
55

6-
Vela plugin to allow detecting code coverage for only the lines changed in a PR.
6+
[Vela](https://go-vela.github.io/docs/) plugin to allow detecting code coverage for only the lines changed in a PR.
77

88
Sometimes when working to get a repo to an acceptable level of code coverage, it can be hard to tell if one change is
99
covered enough. This plugin will look at just the lines changed in the PR and report code coverage for only those
@@ -22,7 +22,7 @@ Currently, this plugin supports two coverage file format.
2222

2323
### Jvm based projects
2424
For java/koltin based projects you need jacoco files that goes as an input to this plugin. How to generate jacoco files is outside the scope of
25-
this project. Once you have that jacoco file, you can pass that path to coverage_file parameters as shown in an example below
25+
this project. Once you have that jacoco file, you can pass that path to coverage_file parameter as shown below
2626

2727
```yaml
2828
- name: check-pr-code-coverage
@@ -87,7 +87,11 @@ Once you have coverage.xml same can be passed as an input to plugin shown below
8787
8888
# Development
8989
90-
This project needs go (>= 1.17) to be installed.
90+
This project needs go (>= 1.17) to be installed. Make sure you run
91+
* make format
92+
* make lint
93+
94+
before submitting a PR
9195
9296
# License
9397
This project is licensed under the Apache License, Version 2.0.

0 commit comments

Comments
 (0)