Skip to content

Commit

Permalink
Resolve coverage misleading infos:
Browse files Browse the repository at this point in the history
Readme github is not showing the real coverage.
Add information about coverage on how-to-contribute
Make CONTRIBUTING.md file more usefull.
Change file location of Contributing so that we profite from github
machinery, reminders to Contribuiting file.
  • Loading branch information
MalloZup committed Jul 28, 2018
1 parent af23e3d commit fe3a003
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 20 deletions.
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# How to contribute to terraform-libvirt-plugin:

## Running the tests (testacc)

```
make testacc
```

### code coverage:

Run first the testacc suite.

Then you can visualize the profile in html format:

```golang
go tool cover -html=profile.cov
```

Feel free to read more about this on : https://blog.golang.org/cover

### Provider terraform useful devel info:

https://www.terraform.io/docs/plugins/provider.html

### Writing acceptance tests:

Take a look at Terraform's docs about [writing acceptance tests](https://github.com/hashicorp/terraform/blob/master/.github/CONTRIBUTING.md#writing-an-acceptance-test).
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
- Planning board: [Github Projects](https://github.com/dmacvicar/terraform-provider-libvirt/projects/1)


![alpha](https://img.shields.io/badge/stability%3F-beta-yellow.svg) [![Build Status](https://travis-ci.org/dmacvicar/terraform-provider-libvirt.svg?branch=master)](https://travis-ci.org/dmacvicar/terraform-provider-libvirt) [![Coverage Status](https://coveralls.io/repos/github/dmacvicar/terraform-provider-libvirt/badge.svg?branch=master)](https://coveralls.io/github/dmacvicar/terraform-provider-libvirt?branch=master)

![alpha](https://img.shields.io/badge/stability%3F-beta-yellow.svg) [![Build Status](https://travis-ci.org/dmacvicar/terraform-provider-libvirt.svg?branch=master)](https://travis-ci.org/dmacvicar/terraform-provider-libvirt)
___
This is a terraform provider that lets you provision
servers on a [libvirt](https://libvirt.org/) host via [Terraform](https://terraform.io/).
Expand All @@ -15,7 +14,7 @@ servers on a [libvirt](https://libvirt.org/) host via [Terraform](https://terraf
- [Installing](#installing)
- [Quickstart](#using-the-provider)
- [Building from source](#building-from-source)
- [How to contribute](doc/CONTRIBUTING.md)
- [How to contribute](CONTRIBUTING.md)

## Website Docs
- [Libvirt Provider](website/docs/index.html.markdown)
Expand Down
17 changes: 0 additions & 17 deletions doc/CONTRIBUTING.md

This file was deleted.

0 comments on commit fe3a003

Please sign in to comment.